IntegrationsIntegrations

Create an integration

Create an integration. Integrations are created in development status by default.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
identifier_field_pathstringRequired

JMESPath describing which of the fields in configuration_fields is the best human-friendly field to use to identify a specific installation (e.g., account name)

authorstringOptional>=1 character<=160 characters
The name of the integration developer
call_to_actionstringOptional>=1 character
The call to action text
configuration_fieldsobjectOptional

A json-schema describing the settings fields that a user should be presented with when installing the integration

contactstringOptional>=1 character
The URL or email address where users of the integration can reach out for support
descriptionstringOptional>=1 character
A description of what the integration does and how to use it
error_codesobjectOptional
An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed
namestringOptional>=1 character<=160 characters
The name of the integration
oauth_callback_urlstringOptionalformat: "url">=1 character

The get endpoint that will be invoked after OAuth authorization

scopeslist of stringsOptional
The list of OAuth token permissions the integration requests when installed
tagslist of enumsOptional
A list of tags that describe the type of integration
Allowed values:
uninstallation_urlstringOptionalformat: "url">=1 character

The delete endpoint that initiates the uninstallation flow for the integration

Response

Platform integration created
client_secretstring
The OAuth client secret for the integration
idstring
The unique identifier for the integration
identifier_field_pathstring

JMESPath describing which of the fields in configuration_fields is the best human-friendly field to use to identify a specific installation (e.g., account name)

statusstring

The current state of the integration (development, approved, archived)

authorstring or null>=1 character<=160 characters
The name of the integration developer
call_to_actionstring or null>=1 character
The call to action text
configuration_fieldsobject or null

A json-schema describing the settings fields that a user should be presented with when installing the integration

contactstring or null>=1 character
The URL or email address where users of the integration can reach out for support
createdstring or nullformat: "date-time"
The date the integration was created
descriptionstring or null>=1 character
A description of what the integration does and how to use it
error_codesobject or null
An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed
namestring or null>=1 character<=160 characters
The name of the integration
oauth_callback_urlstring or nullformat: "url">=1 character

The get endpoint that will be invoked after OAuth authorization

scopeslist of strings or null
The list of OAuth token permissions the integration requests when installed
tagslist of enums or null
A list of tags that describe the type of integration
Allowed values:
uninstallation_urlstring or nullformat: "url">=1 character

The delete endpoint that initiates the uninstallation flow for the integration

updatedstring or nullformat: "date-time"
The date the integration was last updated

Errors