| Name | Description |
|---|---|
| AbstractAdapterRegistration | Base data set for remote adapters. |
| RemoteAdapterRegistration | The data required to register a remote adapter with Chain.io. |
| RemoteAdapterSharedSecret | The data required to update a remote adapter with Chain.io. |
| RemoteAdapterRegistrationUpdate | The data required to update a remote adapter shared secret with Chain.io. |
| IntegrationIdentifier | A unique identifier for a specific flow type. This value controls the specific data that your adapter can expect to receive. Allowed values: co2.register_shipment, co2.receive_co2_update, acctAuto.receive_invoice, acctAuto.send_invoice, acctAuto.send_organization, acctAuto.send_job, acctAuto.receive_payment_receipt, carOps.send_booking, carOps.receive_booking_acknowledgment, carOps.receive_booking_response, carOps.receive_document, vis.register_shipment, vis.receive_shipment_update, rateQuote.send_shipment_rate_request, rateQuote.receive_shipment_rate_response, rateQuote.receive_booking, dataAgg.send_passthrough. |
| InputAdapterFileFilters | List of regular expressions that, if present, are used to filter input files for open connect adapters of type input. The expressions here will be used to determine if the input file is valid for this adapter. If the file is invalid, the associated flow will be not be executed, and no payload will be sent to the open connect adapter. |
| XpathExpression | |
| RemoteAdapter | The data associated with your remote adapter. |
| AbstractConfigurationOption | A single UI component that the user will utilize to enter any configuration values that your adapter will require to function. |
| StringConfigurationOption | A UI component that accepts string user input. |
| PasswordConfigurationOption | A UI component that accepts obscurred user input. |
| RegExConfigurationOption | A UI component that validates the user input by matching it against a provided regular expression. If the input does not match the expression an error message is displayed and the user will not be able to save the configuration. |
| NumberConfigurationOption | A UI component that ensures the user's input will be a numeric value. |
| BooleanConfigurationOption | A UI component that will return a true or false value. |
| ListConfigurationOption | A UI component that will present the user with a list of options to choose from. |
| TableConfigurationLayout | A UI component that will present the user with a table. Each column is configured to display a distinct configuration option. The value returned in the webhook is an array of objects. The keys for the object are the configured configuration items' identifier and the values are their values. |
| ErrorResponse | A generic API error response. |
| RemoteAdapterCallbackRequest | The body of the request your adapter will return to Chain.io |
| RemoteAdapterRequest | The request data that Chain.io will send to a remote adapter. |
| InputAdapterRequestPayload | The payload an input adapter remote adapter can expect to receive from the Chain.io platform |
| InputAdapterRequestPayloadFile | A single file from an input payload. |
| OutputAdapterRequestPayload | The payload an output adapter can expect to receive. This should be the json data representing the integration type schema that your adapter is implementing. The examples here represent a sample payload a vis.register_shipment output adapter could expect to receive from Chain.io. |
| InputAdapterResponsePayload | The payload an input adapter is expected to return in its callback. This should be the json data representing the integration type schema that your adapter is implementing. The examples here represent sample payloads a vis.register_shipment input adapter may return to the callback. |
| OutputAdapterResponsePayload | The expected response for an output adapter. This should be the files that your adapter is emitting to the flow's destination system. |
| RemoteAdapterFile | A file that is emitted by the remote adapter. |
| InputAdapterFileFilters_xpath | |
| XpathExpression_namespaces | |
| RemoteAdapterCallbackRequest_user_logs | |
| RemoteAdapterCallbackRequest_data_tags |
| Name | Data Type | Description | Required |
|---|---|---|---|
integration_identifiers | Array<IntegrationIdentifier> | A list of the Flow Setup types where your adapter should be available | |
display_name | String | The name that will be displayed to the user when selecting the adapter to use in a flow. | |
display_description | String | A short description of your adapter that users will see when they are selecting it. | |
support_url | String | A link that users can follow to learn more about your adapter | |
adapter_type | String | Identifies whether this adapter will considered an input (source) adapter or an output (destination) adapter. Allowed values: input, output. | |
webhook_url | String | The URL that Chain.io should send requests to in order to invoke your adapter. This URL should handle the Chain.io webhook format documented in this API guide. | |
adapter_icon_url | String | A url that Chain.io will use to display an icon with your adapter to users. | |
publication_type | String | If 'public', your adapter will be available to all Chain.io users. If 'private', you must send at least one workspace_associations value to allow users of that workspace to select your adapter. Allowed values: public, private. | |
workspace_associations | Array<String> | A list of the IDs for every workspace that will have access to use your adapter. This list is only utilized if the publication_type is set to 'private'. | |
configuration_options | Array<StringConfigurationOption | RegExConfigurationOption | PasswordConfigurationOption | NumberConfigurationOption | BooleanConfigurationOption | ListConfigurationOption | TableConfigurationLayout> | List of configuration options to present to users when they configure your adapter. The values the user entered for these configuration options will included in the payload send to your webhook_url when your adapter is invoked. |
| Name | Data Type | Description | Required |
|---|---|---|---|
integration_identifiers | Array<IntegrationIdentifier> | A list of the Flow Setup types where your adapter should be available | YES |
display_name | String | The name that will be displayed to the user when selecting the adapter to use in a flow. | YES |
display_description | String | A short description of your adapter that users will see when they are selecting it. | YES |
support_url | String | A link that users can follow to learn more about your adapter | |
adapter_type | String | Identifies whether this adapter will considered an input (source) adapter or an output (destination) adapter. Allowed values: input, output. | YES |
webhook_url | String | The URL that Chain.io should send requests to in order to invoke your adapter. This URL should handle the Chain.io webhook format documented in this API guide. | YES |
adapter_icon_url | String | A url that Chain.io will use to display an icon with your adapter to users. | |
publication_type | String | If 'public', your adapter will be available to all Chain.io users. If 'private', you must send at least one workspace_associations value to allow users of that workspace to select your adapter. Allowed values: public, private. | YES |
workspace_associations | Array<String> | A list of the IDs for every workspace that will have access to use your adapter. This list is only utilized if the publication_type is set to 'private'. | |
configuration_options | Array<StringConfigurationOption | RegExConfigurationOption | PasswordConfigurationOption | NumberConfigurationOption | BooleanConfigurationOption | ListConfigurationOption | TableConfigurationLayout> | List of configuration options to present to users when they configure your adapter. The values the user entered for these configuration options will included in the payload send to your webhook_url when your adapter is invoked. | |
shared_secret | String | The shared secret that Chain.io should utilize when signing requests sent to your webhook url. You will need to utilize this secret to verify the webhook requests were sent by Chain.io. You must also utilize this same secret when signing responses returned to Chain.io. | YES |
input_adapter_file_filters | InputAdapterFileFilters | ||
notification_emails | Array<String> | A list of email addresses whose owners will be notified when the registration request is approved or denied. |
| Name | Data Type | Description | Required |
|---|---|---|---|
shared_secret | String | The shared secret that Chain.io should utilize when signing requests sent to your webhook url. You will need to utilize this secret to verify the webhook requests were sent by Chain.io. You must also utilize this same secret when signing responses returned to Chain.io. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
integration_identifiers | Array<IntegrationIdentifier> | A list of the Flow Setup types where your adapter should be available | YES |
display_name | String | The name that will be displayed to the user when selecting the adapter to use in a flow. | YES |
display_description | String | A short description of your adapter that users will see when they are selecting it. | YES |
support_url | String | A link that users can follow to learn more about your adapter | |
adapter_type | String | Identifies whether this adapter will considered an input (source) adapter or an output (destination) adapter. Allowed values: input, output. | YES |
webhook_url | String | The URL that Chain.io should send requests to in order to invoke your adapter. This URL should handle the Chain.io webhook format documented in this API guide. | YES |
adapter_icon_url | String | A url that Chain.io will use to display an icon with your adapter to users. | |
publication_type | String | If 'public', your adapter will be available to all Chain.io users. If 'private', you must send at least one workspace_associations value to allow users of that workspace to select your adapter. Allowed values: public, private. | YES |
workspace_associations | Array<String> | A list of the IDs for every workspace that will have access to use your adapter. This list is only utilized if the publication_type is set to 'private'. | |
configuration_options | Array<StringConfigurationOption | RegExConfigurationOption | PasswordConfigurationOption | NumberConfigurationOption | BooleanConfigurationOption | ListConfigurationOption | TableConfigurationLayout> | List of configuration options to present to users when they configure your adapter. The values the user entered for these configuration options will included in the payload send to your webhook_url when your adapter is invoked. | |
input_adapter_file_filters | InputAdapterFileFilters | ||
notification_emails | Array<String> | A list of email addresses whose owners will be notified when the registration request is approved or denied. |
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|---|---|---|
warning_message_for_user | String | A message to the warn the user that this adapter will cause inputs to the flow to be filtered. Please include information describing what criteria are used in the filter. | YES |
xpath | InputAdapterFileFilters_xpath |
| Name | Data Type | Description | Required |
|---|---|---|---|
namespaces | Array<XpathExpression_namespaces> | ||
xpath | String |
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|---|---|---|
name | String | The name of the configuration option that will be passed to your webhook. This property is functionally equivalent to the name attribute used in HTML form components. Do not use the same name for multiple options in your adapter. | |
label | String | The name of the option that will be displayed to the user. | |
description | String | A short description that will be shown to the user as help text when they are configuring the option. | |
support_url | String | A link that users can follow to learn more about this adapter configuration item. | |
config_type | String | The data type of the configuration option. See the Configuration Data Types guide article for more details. Allowed values: string, password, regex, number, boolean, list, table. | |
required | Boolean | Should the user be required to complete this option? Does not apply to boolean and table config types. |
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|---|---|---|
status_code | Integer | Standard http status code returned with this error. | |
error_type | String | Allowed values: invalid_token, invalid_token, invalid_signature, invalid_request, unknown_error. | |
messages | Array<String> |
| Name | Data Type | Description | Required |
|---|---|---|---|
status | String | See the Core Concepts page in the guide to learn more about the statuses you can return. Allowed values: success, skipped, error, bug. | |
user_logs | Array<RemoteAdapterCallbackRequest_user_logs> | List of user log messages to display to user in the Chain.io portal's flow execution results page. | |
callback | String | Return the exact callback string that Chain.io sent to your webhook_url. | |
files | Array<RemoteAdapterFile> | A list of additional files to provide to the user in the Flow Execution screen. These files are not passed to other adapters. You may return up to 5 files per adapter execution. Each file may be up to 100 MB in size. If you require larger files, we recommend hosting the files with your own solution and providing a link to the files in a user_log message. | |
data_tags | Array<RemoteAdapterCallbackRequest_data_tags> | List of data tags to display to the user. These tags are utilized by the user to search for specific executions of the flow that involved your adapter. | |
payload | InputAdapterResponsePayload | OutputAdapterResponsePayload |
| Name | Data Type | Description | Required |
|---|---|---|---|
callback | String | A string unique to every single request payload sent to the remote adapter. This callback value must be returned verbatim in every single response sent back to Chain.io's callback endpoint. | YES |
configuration | Object | All the configuration values the user set up in the Chain.io Portal for this flow. | YES |
payload | InputAdapterRequestPayload | OutputAdapterRequestPayload | The actual flow data the remote adapter should process. For input adapters this will be an array of the files that were received by the flow. For output adapters this will be a json object formatted in the shape of the specific solution schema the adapter is registered to participate in. | YES |
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|---|---|---|
file_name | String | The file name. Whenever possible this name will represent the exact file name of the file as received by Chain.io. Some transfer formats, like http, do not lend themselves to providing filenames. In those cases Chain.io will generate the file name and use some file heuristics to provide a best guess on the extension to utilize. | YES |
mime_type | String | The media type Chain.io has determined best fits the file. Transfer formats like http that provide media types will typically provide the most accurate mime types. For transfer formats like sftp Chain.io will use a best guest approach to determining the mime_type based on the file name. | YES |
body | String | The raw file contents received by Chain.io. See the content_transfer_encoding to determine the charset to use to decode the file contents. | YES |
content_transfer_encoding | String | The encoding used to transfer the file body. Allowed values: utf8, base64. | YES |
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|
| Name | Data Type | Description | Required |
|---|---|---|---|
file_name | String | The name of the file that will be displayed to the user. We strongly encourage utilizing standard file name extensions (.json, .xml, etc) to allow users to utilize our inline web file viewer to access these files. | YES |
file_type | String | A simple file descriptor that will be displayed to the user to help them understand what the contents of the file represent. | |
mime_type | String | The IANA media type of the file your adapter is emitting. This is the content-type of your file. | YES |
body | String | The contents of the file. For character based files like json or xml, this should be the actual string representation of the data. JSON data should be stringified. | YES |
content_transfer_encoding | String | The encoding used to transfer the file body. File bodies that cannot be represented as a UTF-8 string in a json payload must first be encoded in an accepted encoding before being transferred. Typically, this is required for most mime_types that are NOT text/plain, application/json or application/xml. This field can be excluded when no transfer encoding is applied, in which case, utf8 encoding will be assumed. Allowed values: base64, utf8. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
matches_all_expressions | Array<XpathExpression> | ||
matches_any_expression | Array<XpathExpression> |
| Name | Data Type | Description | Required |
|---|---|---|---|
prefix | String | ||
namespace | String |
| Name | Data Type | Description | Required |
|---|---|---|---|
level | String | Log level which will be displayed to users. Allowed values: info, warning, error. | YES |
message | String | The actual log message to display to the users. | YES |
timestamp | DateTime | The timestamp of when message was generated in ISO-8601 format. If no timezone is present, then the system will assume a timezone of UTC. | YES |
| Name | Data Type | Description | Required |
|---|---|---|---|
label | String | The type of data represented by the tag value. The label is not searchable by the user. | YES |
value | String | The searchable value for this tag. | YES |