API Reference

Update Adapter

put
https://webhooks.chain.io/adapters/

Update your remote adapter configuration.

Path Params
string
required

The unique id value associated with your adapter returned by the create adapter API call.

Body Params
integration_identifiers
array of objects
required

A list of the Flow Setup types where your adapter should be available

integration_identifiers*
string
required

The name that will be displayed to the user when selecting the adapter to use in a flow.

string
required

A short description of your adapter that users will see when they are selecting it.

string

A link that users can follow to learn more about your adapter

string
enum
required

Identifies whether this adapter will considered an input (source) adapter or an output (destination) adapter.

Allowed:
string
required

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.

string

A url that Chain.io will use to display an icon with your adapter to users.

string
enum
required

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:
workspace_associations
array of strings

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'.

workspace_associations
configuration_options
array

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.

configuration_options
Headers
string
enum
Allowed:
Responses

Updated 11 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 11 months ago