IntegrationsIntegrations

Create an integration

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

Authentication

AuthorizationBearer

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)

namestringRequired>=1 character<=160 characters
The name of the integration
descriptionstringRequired>=1 character
A description of what the integration does and how to use it
authorstringRequired>=1 character<=160 characters
The name of the integration developer
contactstringRequired>=1 character
The URL or email address where users of the integration can reach out for support
uninstallation_urlstringRequiredformat: "url">=1 character

The delete endpoint that initiates the uninstallation flow for the integration

oauth_callback_urlstringRequiredformat: "url">=1 character

The get endpoint that will be invoked after OAuth authorization

tagslist of enumsRequired
A list of tags that describe the type of integration
Allowed values:
scopeslist of stringsRequired
The list of OAuth token permissions the integration requests when installed
configuration_fieldsobjectRequired

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

icon_urlstring or nullOptionalformat: "url">=1 character
The URL of the icon that should be displayed with your integration
call_to_actionstring or nullOptional>=1 character
The call to action text
error_codesobject or nullOptional
An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed

Response

Platform integration created
authorstring>=1 character<=160 characters
The name of the integration developer
configuration_fieldsobject

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

contactstring>=1 character
The URL or email address where users of the integration can reach out for support
descriptionstring>=1 character
A description of what the integration does and how to use it
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)

namestring>=1 character<=160 characters
The name of the integration
oauth_callback_urlstringformat: "url">=1 character

The get endpoint that will be invoked after OAuth authorization

scopeslist of strings
The list of OAuth token permissions the integration requests when installed
statusstring

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

tagslist of enums
A list of tags that describe the type of integration
Allowed values:
uninstallation_urlstringformat: "url">=1 character

The delete endpoint that initiates the uninstallation flow for the integration

call_to_actionstring or null>=1 character
The call to action text
client_secretstring or null
The OAuth client secret for the integration
createdstring or nullformat: "date-time"
The date the integration was created
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
icon_urlstring or nullformat: "url">=1 character
The URL of the icon that should be displayed with your integration
updatedstring or nullformat: "date-time"
The date the integration was last updated

Errors