Contact Us 1-800-596-4880
  1. Homepage
  2. Roostify Connector (1.0)

  3. Roostify Connector Reference

All Connectors

Roostify Connector Reference - Mule 4

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

Configurations

Default Configuration

Default configuration

Parameters

Name Type Description Default Value 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

Operations

Activate a User

<roostify:activate-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

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

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Response Status

For Configurations

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

Deactivate a User

<roostify:cancel-order>

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

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

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Response Status

For Configurations

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 an Access Control Group

<roostify:create-access-control>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 or Update a Reference ID

<roostify:create-update-reference-id>

Reference IDs allow users to work with an external service or integration. Using this route either creates or updates a reference ID.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 User

<roostify:create-user>

Create a user.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Upload or Create a Document

<roostify:creating-document>

To upload a document, POST the document as JSON to /documents. The file_content in your payload body should be the base64 encoded bytes of the document.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Task from a File Content Task

<roostify:creating-file-content-task>

Create a task from a file content task.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Lead

<roostify:creating-lead>

The leads endpoint accepts parameters to create a Lead in Roostify. Each parameter must be allowlisted or it is not allowed within the system.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Loan Application

<roostify:creating-loan-application>

Creating a loan application must be granted on a service by service basis. Access is denied by default. A Loan Application may be created with any of the attributes listed above as parameters to the API.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

<roostify:creating-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.

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Task from a Regular Task

<roostify:creating-regular-task>

Create a task from a regular task.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Task from a Speed-bump Task

<roostify:creating-speed-bump-task>

Create a task from a speed-bump task.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Status Update

<roostify:creating-status-update>

A status update appears in the Stream that collaborators use to monitor updates to a loan application.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Task from an Approval Task

<roostify:creating-task-from-approval>

Create a new task from an approval task.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Task from a Form Task

<roostify:creating-task-from-form>

Create a new task from a form task.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Task from a View-only Task

<roostify:creating-view-only-task>

Create a talk from a view-only task.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Webhook

<roostify:creating-webhook>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Delete a Webhook

<roostify:deleting-webhook>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Download a Document

<roostify:downloading-document>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Lead

<roostify:get-lead>

The leads endpoint accepts parameters to create a Lead in Roostify. Each parameter must be allowlisted or it is not allowed within the system.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

List Messages

<roostify:get-messages>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Streaming Strategy

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

List Accounts

<roostify:listing-accounts>

Retrieve a list of all accounts.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

List Documents

<roostify:listing-documents>

Retrieve metadata for documents.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

List Loan Applications

<roostify:listing-loan-applications>

This retrieves all loan applications belonging to your account or its descendants. For clients with many loan applications, this may time out if you do not use pagination.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Listing Tasks

<roostify:listing-tasks>

Return a list of all tasks and their details.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

List Users

<roostify:listing-users>

List all users with their details.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Listing Webhook Events

<roostify:listing-webhook-events>

Webhook events record every instance in which a webhook was fired for a particular event, and can act as an audit log for all events that occur that are trackable via webhooks.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

List Webhooks

<roostify:listing-webhooks>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Loan Application by Reference ID

<roostify:loan-application-by-reference-id>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Loan Application in FNM Format

<roostify:loan-applications-fnm>

Unlike most of the API, the loan applications FNM endpoint returns plaintext instead of JSON. The string returned is a Base64-encoded Fannie Mae file.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Response Status

For Configurations

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 Loan Application

<roostify:loan-applications-id>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Loan Application in MISMO Format

<roostify:loan-applications-mismo>

The ability to download a loan application in MISMO format must be requested from your Partner or Client Success Manager.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Response Status

For Configurations

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

<roostify:retrieve-your-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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Task

<roostify:retrieving-a-task>

Retrieve a single task details.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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:retrieving-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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Document Metadata

<roostify:retrieving-document>

Retrieve the metadata for a document.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Message

<roostify:retrieving-message>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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:retrieving-settings>

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 User

<roostify:retrieving-user>

Get details of a single user.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 Webhook

<roostify:retrieving-webhook>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Update an Access Control Group

<roostify:update-access-control>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Update a Document Metadata

<roostify:update-document>

Update a documents metadata and returns the documents metadata.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Update a Task

<roostify:update-task>

Update details of a single task.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Update a User

<roostify:update-user>

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Binary

Attributes Type

Response Status

For Configurations

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

Update a Loan Application

<roostify:updating-loan-application>

Updating a loan application must be granted on a service by service basis. Access is denied by default.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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 User Settings

<roostify:user-settings>

Retrieving settings for a particular user also returns the account settings for the account they are on. This reduces complexity by allowing you to make a single request for all a particular users settings.

Parameters

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

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

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Response Status

For Configurations

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

Types

Default

Field Type Description Default Value 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 Default Value Required

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

Trust Store

Field Type Description Default Value Required

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 Default Value Required

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 Default Value Required

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

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

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 Default Value Required

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

MuleSoft Help Center

Back to top
View on GitHub