--- schema_version: "1" id: ddba493da630db34592b384e775338eca0c7016ff071d67e161df23f975cd0f7 title: Roostify Connector Reference collection: mulesoft version: current locale: en-us portal_url: https://docs.salesforce.com/mulesoft/current/en-us/roostify-connector/latest/roostify-connector-reference.md canonical_url: https://docs.mulesoft.com/roostify-connector/latest/roostify-connector-reference source_site: docs.mulesoft.com content_type: documentation content_hash: f8824f19ef79e6f880264fcfbbcc38bbad6e606baf6e6f09c0b4625c83ecec08 description: MuleSoft Documentation Site release: "1.0" latest: true --- --- product: Roostify Connector version: 1.0 is-latest-version: true --- # Roostify Connector Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Roostify Connector v1.0 Anypoint Connector for Roostify (Roostify Connector) enables customers to convert completed loan applications to an optimized and intuitive digital user experience, tailored to each DBA, branch, or channel. This is the main class of an extension, and is the entry point from which configurations, connection providers, operations and sources are declared. Release Notes: [Roostify Connector Release Notes](https://docs.mulesoft.com/release-notes/connector/roostify-connector-release-notes-mule-4) ## Configurations --- ### Default Configuration Default configuration #### Parameters

Name	Type	Description	Required
Name	String	The name for this configuration. Connectors reference the configuration with this name.	x
Connection	Connection	The connection types to provide to this configuration.	x
Address	String		x
Version	String		x
Expiration Policy	Expiration Policy	Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

#### Connection Types ##### Connection ###### Parameters

Name	Type	Description	Default Value	Required
Username	String			x
Password	String			x
Proxy Configuration	Default
Use Persistent Connections	Boolean		true
Max Connections	Number		-1
Connection Idle Timeout	Number		60000
Stream Response	Boolean		false
Response Buffer Size	Number		-1
Connection Timeout	Number		60000
TLS Configuration	TLS
Reconnection	Reconnection	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy

## Supported Operations - [Activate a User](#activateUser) - [Create a Lead](#creatingLead) - [Create a Loan Application](#creatingLoanApplication) - [Create a Message](#creatingMessage) - [Create a Status Update](#creatingStatusUpdate) - [Create a Task from a File Content Task](#creatingFileContentTask) - [Create a Task from a Form Task](#creatingTaskFromForm) - [Create a Task from a Regular Task](#creatingRegularTask) - [Create a Task from a Speed-bump Task](#creatingSpeedBumpTask) - [Create a Task from a View-only Task](#creatingViewOnlyTask) - [Create a Task from an Approval Task](#creatingTaskFromApproval) - [Create a Webhook](#creatingWebhook) - [Create a User](#createUser) - [Create an Access Control Group](#createAccessControl) - [Create or Update a Reference ID](#createUpdateReferenceId) - [Deactivate a User](#cancelOrder) - [Delete a Webhook](#deletingWebhook) - [Download a Document](#downloadingDocument) - [List Accounts](#listingAccounts) - [List Documents](#listingDocuments) - [List Loan Applications](#listingLoanApplications) - [List Messages](#getMessages) - [List Users](#listingUsers) - [List Webhooks](#listingWebhooks) - [Listing Tasks](#listingTasks) - [Listing Webhook Events](#listingWebhookEvents) - [Retrieve a Document Metadata](#retrievingDocument) - [Retrieve a Lead](#getLead) - [Retrieve a Loan Application](#loanApplicationsId) - [Retrieve a Loan Application by Reference ID](#loanApplicationByReferenceId) - [Retrieve a Loan Application in FNM Format](#loanApplicationsFNM) - [Retrieve a Loan Application in MISMO Format](#loanApplicationsMISMO) - [Retrieve a Message](#retrievingMessage) - [Retrieve a Service](#retrieveYourService) - [Retrieve a Task](#retrievingATask) - [Retrieve a User](#retrievingUser) - [Retrieve a User Settings](#userSettings) - [Retrieve a Webhook](#retrievingWebhook) - [Retrieve an Account](#retrievingAccount) - [Retrieve an Integration Service](#retrievingSettings) - [Update a Document Metadata](#updateDocument) - [Update a Loan Application](#updatingLoanApplication) - [Update a Task](#updateTask) - [Update a User](#updateUser) - [Update an Access Control Group](#updateAccessControl) - [Upload or Create a Document](#creatingDocument) ## Operations ### Activate a User `` #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Id	String	User ID (Required).		x
Output Mime Type	String	The mime type of the payload that this operation outputs.
Output Encoding	String	The encoding of the payload that this operation outputs.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Id	String	User ID (Required).		x
Output Mime Type	String	The mime type of the payload that this operation outputs.
Output Encoding	String	The encoding of the payload that this operation outputs.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Access Control	Object	Create access control request body	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Loan_id	String	ID of the loan application to update.		x
Reference Body	Object	The request body for updating the loan.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
User Body	Object	Roostify create user request body.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Document	Object	Request body for create a document	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
File Content Task	Object	Request body for creating a task from a file content task.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Create Lead	Object	The request body for creating a lead.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Create Loan Request	Object	Create loan request body.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

#### For Configurations - [Default Configuration](#config) #### Throws - ROOSTIFY:BAD\_GATEWAY - ROOSTIFY:INTERNAL\_SERVER\_ERROR - ROOSTIFY:METHOD\_NOT\_ALLOWED - ROOSTIFY:UN\_PROCESSABLE\_ENTITY - ROOSTIFY:NOT\_IMPLEMENTED - ROOSTIFY:CONNECTIVITY - ROOSTIFY:GENERIC\_EXCEPTION - ROOSTIFY:NOT\_ACCEPTABLE - ROOSTIFY:NOT\_FOUND - ROOSTIFY:SERVICE\_UNAVAILABLE - ROOSTIFY:RETRY\_EXHAUSTED - ROOSTIFY:UNAUTHORIZED - ROOSTIFY:FORBIDDEN - ROOSTIFY:EMPTY\_HEAD\_COUNT - ROOSTIFY:CONFLICT - ROOSTIFY:BAD\_REQUEST - ROOSTIFY:DEAD\_TOKEN - ROOSTIFY:REQUEST\_TIMEOUT ### Create a Message `` When the accounts email and name are filled in, the from address for messages created from this endpoint uses the account name and email address. Otherwise, emails are sent from an email address similar to [no-reply@deliver.roostify.com](mailto:no-reply@deliver.roostify.com). #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Message	Object	Message request body for creating message.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Regular Task	Object	Request body for creating a task from a regular task.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Speed Bump Task	Object	Request body for creating a task from a speed-bump task.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Status	Object	Request body for create status update	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Approval Task	Object	Request body for creating a task from an approval task.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Form Task	Object	Request body for creating a task from a form task.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
View Only Task	Object	Request body for creating a task from a view-only task.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Webhook Body	Object	Request body for create webhook	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Webhook Id	String	ID of the webhook to destroy.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Id	String	Required. ID of the document to retrieve.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Lead Id	String	ID of the lead.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Page	String	Indicates the page of the index which should be returned. When this parameter is not present and count is, it defaults to 1. When both parameters are not present, the pagination is disabled.
Count	String	Indicates the number of records per page returned. When this parameter is not present and page is, it defaults to 100. When both parameters are not present, the pagination is disabled.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Page	String	Indicates the page of the index which should be returned. When this parameter is not present and count is, it defaults to 1. When both parameters are not present pagination is disabled.
Count	String	Indicates the number of records per page returned. When this parameter is not present and page is, it defaults to 100. When both parameters are not present pagination is disabled.
Filter	String	Term for filtering document metadata based presence of reference_id.
Search	String	Terms for searching document metadata. Current searchable terms are: document_name, loan_application_reference_id, and loan_application_id.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Search	String	Only lists loan applications which match the given attributes. Param structure is search[attribute]=…
Page	String	Indicates the page of the index which should be returned. When this parameter is not present and count is, it defaults to 1. When both parameters are not present pagination is disabled.
Count	String	Indicates the number of records per page returned. When this parameter is not present and page is, it defaults to 100. When both parameters are not present pagination is disabled.
Created	String	Filters loan applications based on when loan applications are created. The string must be formatted as two ISO-8601 datestamps separated by '…'. If the time zone designator is omitted it defaults to UTC.
Submitted	String	Filters loan applications based on when loan applications are submitted. The string must be formatted as two ISO-8601 datestamps separated by '…'. If the time zone designator is omitted it defaults to UTC.
Updated	String	Filters loan applications based on when loan applications are updated. The string must be formatted as two ISO-8601 datestamps separated by '…'. If the time zone designator is omitted it defaults to UTC.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Loan_application_id	String	Loan application ID to search for associated tasks.
Page	String	Indicates the page number which should be returned. When this parameter is not present and count is, it defaults to 1. When both parameters are not present pagination is disabled.
Count	String	Indicates the number of records per page returned. When this parameter is not present and page is, it defaults to 100. When both parameters are not present pagination is disabled.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Page	String	Indicates the page of the index which should be returned. When this parameter is not present and count is, it defaults to 1. When both parameters are not present pagination is disabled.
Count	String	Indicates the number of records per page returned. When this parameter is not present and page is, it defaults to 100. When both parameters are not present pagination is disabled.
Search	String	Only lists users that match the given attributes. Param structure is search[attribute]=… Takes a url encoded hash of search parameters.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Page	String	Indicates the page of the index which should be returned. When this parameter is not present and count is, it defaults to 1. When both parameters are not present pagination is disabled.
Count	String	Indicates the number of records per page returned. When this parameter is not present and page is, it defaults to 100. When both parameters are not present pagination is disabled.
Created	String	ISO 8601 DateTime range. Scope the returned results to only webhook events that were created this range of dates.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Page	String	Indicates the page of the index which should be returned. When this parameter is not present and count is, it defaults to 1. When both parameters are not present pagination is disabled.
Count	String	Indicates the number of records per page returned. When this parameter is not present and page is, it defaults to 100. When both parameters are not present pagination is disabled.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Reference Id	String	ID of the loan application to retrieve.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Id	String	ID of the loan application to retrieve.		x
Output Mime Type	String	The mime type of the payload that this operation outputs.
Output Encoding	String	The encoding of the payload that this operation outputs.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Find_id	String	ID of the loan application to retrieve.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Id	String	ID of the loan application to retrieve.		x
Output Mime Type	String	The mime type of the payload that this operation outputs.
Output Encoding	String	The encoding of the payload that this operation outputs.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	Response Status

#### For Configurations - [Default Configuration](#config) #### Throws - ROOSTIFY:BAD\_GATEWAY - ROOSTIFY:INTERNAL\_SERVER\_ERROR - ROOSTIFY:METHOD\_NOT\_ALLOWED - ROOSTIFY:UN\_PROCESSABLE\_ENTITY - ROOSTIFY:NOT\_IMPLEMENTED - ROOSTIFY:CONNECTIVITY - ROOSTIFY:GENERIC\_EXCEPTION - ROOSTIFY:NOT\_ACCEPTABLE - ROOSTIFY:NOT\_FOUND - ROOSTIFY:SERVICE\_UNAVAILABLE - ROOSTIFY:RETRY\_EXHAUSTED - ROOSTIFY:UNAUTHORIZED - ROOSTIFY:FORBIDDEN - ROOSTIFY:EMPTY\_HEAD\_COUNT - ROOSTIFY:CONFLICT - ROOSTIFY:BAD\_REQUEST - ROOSTIFY:DEAD\_TOKEN - ROOSTIFY:REQUEST\_TIMEOUT ### Retrieve a Service `` Applications built on Roostify often need to have configuration or other kinds of data tied to a particular user or account. For instance, if building a product to synchronize loan applications from Roostify to a loan origination system, you may want to have lenders provide their username for the loan origination system so you can properly assign them. These are considered User Settings. Account Settings are for data that is shared across a collection of users on an account. Lenders and account admins may set the values for these settings through the Roostify UI. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Task Id	String	ID of task.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

#### For Configurations - [Default Configuration](#config) #### Throws - ROOSTIFY:BAD\_GATEWAY - ROOSTIFY:INTERNAL\_SERVER\_ERROR - ROOSTIFY:METHOD\_NOT\_ALLOWED - ROOSTIFY:UN\_PROCESSABLE\_ENTITY - ROOSTIFY:NOT\_IMPLEMENTED - ROOSTIFY:CONNECTIVITY - ROOSTIFY:GENERIC\_EXCEPTION - ROOSTIFY:NOT\_ACCEPTABLE - ROOSTIFY:NOT\_FOUND - ROOSTIFY:SERVICE\_UNAVAILABLE - ROOSTIFY:RETRY\_EXHAUSTED - ROOSTIFY:UNAUTHORIZED - ROOSTIFY:FORBIDDEN - ROOSTIFY:EMPTY\_HEAD\_COUNT - ROOSTIFY:CONFLICT - ROOSTIFY:BAD\_REQUEST - ROOSTIFY:DEAD\_TOKEN - ROOSTIFY:REQUEST\_TIMEOUT ### Retrieve an Account `` Roostify users are members of an account. Accounts manages billing, permissions, service integrations, application and workflow customizations, co-branding styles, etc. You may access the basic information of any account that has an integration with your service. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Id	String	ID of the account.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Find_id	String	ID of the document to retrieve.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Message Id	String	ID of the message to retrieve.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

#### For Configurations - [Default Configuration](#config) #### Throws - ROOSTIFY:BAD\_GATEWAY - ROOSTIFY:INTERNAL\_SERVER\_ERROR - ROOSTIFY:METHOD\_NOT\_ALLOWED - ROOSTIFY:UN\_PROCESSABLE\_ENTITY - ROOSTIFY:NOT\_IMPLEMENTED - ROOSTIFY:CONNECTIVITY - ROOSTIFY:GENERIC\_EXCEPTION - ROOSTIFY:NOT\_ACCEPTABLE - ROOSTIFY:NOT\_FOUND - ROOSTIFY:SERVICE\_UNAVAILABLE - ROOSTIFY:RETRY\_EXHAUSTED - ROOSTIFY:UNAUTHORIZED - ROOSTIFY:FORBIDDEN - ROOSTIFY:EMPTY\_HEAD\_COUNT - ROOSTIFY:CONFLICT - ROOSTIFY:BAD\_REQUEST - ROOSTIFY:DEAD\_TOKEN - ROOSTIFY:REQUEST\_TIMEOUT ### Retrieve an Integration Service `` Roostify Services are customizable on an account level. The /settings endpoint provides access to the service settings and configurations. These are returned as key/value pairs. For instance, if Roostify leverages an Integration that requires configurations, these fields, values, and the associated Lender on the Account are returned via this GET request. #### Parameters

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
User Id	String	ID of the user		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Webhook Id	String	ID of the webhook to retrieve.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Access Control Group	Object	Update access control request body	`#[payload]`
Id	String	ID or system name of the task. If searching for an id matching the string given yields no results, then a lookup against system name is attempted.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Document Body	Object	Request body for update a document	`#[payload]`
Id	String	ID of the document to update.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Task Body	Object	Request body for updating task.	`#[payload]`
Task Id	String	ID of the task.		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
User	Object	Request body for update user	`#[payload]`
Id	String	User ID.		x
Output Mime Type	String	The mime type of the payload that this operation outputs.
Output Encoding	String	The encoding of the payload that this operation outputs.
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Binary
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Update_id	String	ID of the loan application to update.		x
Update Loan Request	Object	Request body for updating loan application.	`#[payload]`
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Name	Type	Description	Default Value	Required
Configuration	String	The name of the configuration to use.		x
Id	String	Id of the user whose settings you would like to retrieve		x
Streaming Strategy	Repeatable In Memory Stream Repeatable File Store Stream non-repeatable-stream	Configure to use repeatable streams.
Target Variable	String	The name of a variable to store the operation’s output.
Target Value	String	An expression to evaluate against the operation’s output and store the expression outcome in the target variable	`#[payload]`
Reconnection Strategy	Reconnect Reconnect Forever	A retry strategy in case of connectivity errors.

#### Output

Type	Any
Attributes Type	Response Status

Field	Type	Description	Required
Host	String	Host where the proxy requests is sent.	x
Port	Number	Port where the proxy requests is sent.	x
Username	String	The username to authenticate against the proxy.
Password	String	The password to authenticate against the proxy.
Non Proxy Hosts	String	A list of comma-separated hosts against which the proxy should not be used

### TLS

Field	Type	Description
Enabled Protocols	String	A comma-separated list of protocols enabled for this context.
Enabled Cipher Suites	String	A comma-separated list of cipher suites enabled for this context.
Trust Store	Trust Store
Key Store	Key Store
Revocation Check	Standard Revocation Check Custom OCSP Responder CRL File

### Trust Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.
Password	String	The password used to protect the trust store.
Type	String	The type of store used.
Algorithm	String	The algorithm used by the trust store.
Insecure	Boolean	If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.

### Key Store

Field	Type	Description
Path	String	The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.
Type	String	The type of store used.
Alias	String	When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.
Key Password	String	The password used to protect the private key.
Password	String	The password used to protect the key store.
Algorithm	String	The algorithm used by the key store.

### Standard Revocation Check

Field	Type	Description
Only End Entities	Boolean	Only verify the last element of the certificate chain.
Prefer CRLs	Boolean	Try CRL instead of OCSP first.
No Fallback	Boolean	Do not use the secondary checking method (the one not selected before).
Soft Fail	Boolean	Avoid verification failure when the revocation server can not be reached or is busy.

### Custom OCSP Responder

Field	Type	Description	Default Value	Required
Url	String	The URL of the OCSP responder.
Cert Alias	String	Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

### CRL File

Field	Type	Description	Default Value	Required
Path	String	The path to the CRL file.

### Reconnection

Field	Type	Description	Default Value	Required
Fails Deployment	Boolean	When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.
Reconnection Strategy	Reconnect Reconnect Forever	The reconnection strategy to use.

### Reconnect

Field	Type	Description	Default Value
Frequency	Number	How often in milliseconds to reconnect.
Count	Number	How many reconnection attempts to make.
blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.	true

### Reconnect Forever

Field	Type	Description	Default Value	Required
Frequency	Number	How often in milliseconds to reconnect.
blocking	Boolean	If false, the reconnection strategy runs in a separate, non-blocking thread.	true

### Expiration Policy

Field	Type	Description	Default Value	Required
Max Idle Time	Number	A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration
Time Unit	Enumeration, one of: NANOSECONDS MICROSECONDS MILLISECONDS SECONDS MINUTES HOURS DAYS	A time unit that qualifies the maxIdleTime attribute

### Response Status

Field	Type	Description	Default Value	Required
Headers	Object
Status Code	Number

### Repeatable In Memory Stream

Field	Type	Description
Initial Buffer Size	Number	The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.
Buffer Size Increment	Number	This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.
Max Buffer Size	Number	The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit in which all these attributes are expressed

### Repeatable File Store Stream

Field	Type	Description	Default Value	Required
Max In Memory Size	Number	Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it will start to buffer the content on disk.
Buffer Unit	Enumeration, one of: BYTE KB MB GB	The unit in which maxInMemorySize is expressed

## See Also [Salesforce Help](https://help.salesforce.com)