Create Adapter

post

https://webhooks.chain.io/adapters

Create a new Chain.io Adapter

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The data required to register a remote adapter with Chain.io.

integration_identifiers

array of objects

required

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

integration_identifiers*

display_name

string

required

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

display_description

string

required

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

enum

required

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

Allowed:

webhook_url

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.

adapter_icon_url

string

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

publication_type

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

shared_secret

string

required

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.

Headers

content-type

string

enum

Allowed:

Responses

200200

400400

401401