platformIntegrations

Create an integration

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

post/v2/platform-integrations/

Request

  • Base URL: https://example.ada.support/api
  • URL: https://example.ada.support/api/v2/platform-integrations/
  • Auth: HTTP bearer

Request body

identifier_field_pathstring required

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)

icon_urlstring url nullable

The URL of the icon that should be displayed with your integration

call_to_actionstring nullable

The call to action text

namestring required

The name of the integration

descriptionstring required

A description of what the integration does and how to use it

authorstring required

The name of the integration developer

contactstring required

The URL or email address where users of the integration can reach out for support

uninstallation_urlstring url required

The delete endpoint that initiates the uninstallation flow for the integration

oauth_callback_urlstring url required

The get endpoint that will be invoked after OAuth authorization

tagsPlatformIntegrationCreateRequestTagsItems[] required

A list of tags that describe the type of integration

error_codesPlatformIntegrationCreateRequestErrorCodes

An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed

scopesstring[] required

The list of OAuth token permissions the integration requests when installed

configuration_fieldsPlatformIntegrationCreateRequestConfigurationFields required

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

Response

Platform integration created

idstring required

The unique identifier for the integration

statusstring required

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

createdstring date-time

The date the integration was created

updatedstring date-time

The date the integration was last updated

identifier_field_pathstring required

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)

icon_urlstring url nullable

The URL of the icon that should be displayed with your integration

call_to_actionstring nullable

The call to action text

namestring required

The name of the integration

descriptionstring required

A description of what the integration does and how to use it

authorstring required

The name of the integration developer

contactstring required

The URL or email address where users of the integration can reach out for support

uninstallation_urlstring url required

The delete endpoint that initiates the uninstallation flow for the integration

oauth_callback_urlstring url required

The get endpoint that will be invoked after OAuth authorization

tagsPlatformIntegrationTagsItems[] required

A list of tags that describe the type of integration

error_codesPlatformIntegrationErrorCodes

An object containing error codes and their corresponding error message the integration may return to the OAuth failure page to be displayed

scopesstring[] required

The list of OAuth token permissions the integration requests when installed

configuration_fieldsPlatformIntegrationConfigurationFields required

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

client_secretstring

The OAuth client secret for the integration

Changes

No recorded changes to this operation across all 1 revision of this API.