BackendHTTP APIIntegrations

Create an integration

Requires an API key with the environment:integrations:create scope. Learn more about API key scopes.

Response example

Example Response
{
  "data": {
    "unique_key": "slack-nango-community",
    "display_name": "Slack",
    "provider": "slack",
    "logo": "http://localhost:3003/images/template-logos/github.svg",
    "missing_fields": [],
    "created_at": "2023-10-16T08:45:26.241Z",
    "updated_at": "2023-10-16T08:45:26.241Z",
  }
}
POST
/integrations

Create an integration

Authorization

bearerAuth
headerAuthorizationBearer <token>

An Environment API key from your Tenklo environment, or an Account API key for account-level endpoints.

Request Body

application/json
  1. body
unique_key*string

A unique integration ID, which you will use in the other API calls to reference this integration.

provider*string

The provider unique name.

display_name?string

The integration display name.

forward_webhooks?boolean

Whether to forward webhooks received for this integration. Defaults to true.

credentials?||||

Developer app credentials for the integration. Omit them to create the integration without credentials and provide them later, either with an update request or per connection at connection time.

integration_config?

Provider-specific configuration for providers that declare an integration_config schema (e.g. private-api-generic, aws-sigv4). Keys and required fields depend on the provider; values are validated against the provider schema.

Response Body

Successfully created an integration

application/json
  1. response
data*
Example Request
curl -X POST 'https://api.tenklo.dev/integrations' \  -H 'Content-Type: application/json' \  -d '{  "unique_key": "string",  "provider": "string"}'
Example Response
{  "data": {    "unique_key": "string",    "display_name": "string",    "provider": "string",    "logo": "string",    "created_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "forward_webhooks": true,    "missing_fields": [      "string"    ]  }}