Skip to main content
POST
/
integrations
Create an integration
curl --request POST \
  --url https://api.nango.dev/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "unique_key": "<string>",
  "provider": "<string>",
  "display_name": "<string>",
  "forward_webhooks": true,
  "credentials": {
    "client_id": "<string>",
    "client_secret": "<string>",
    "scopes": "<string>",
    "webhook_secret": "<string>"
  },
  "integration_config": {}
}
'
{
  "data": {
    "unique_key": "slack-nango-community",
    "display_name": "Slack",
    "provider": "slack",
    "logo": "http://localhost:3003/images/template-logos/github.svg",
    "created_at": "2023-10-16T08:45:26.241Z",
    "updated_at": "2023-10-16T08:45:26.241Z",
  }
}
Requires an API key with the environment:integrations:create scope. Learn more about API key scopes.
{
  "data": {
    "unique_key": "slack-nango-community",
    "display_name": "Slack",
    "provider": "slack",
    "logo": "http://localhost:3003/images/template-logos/github.svg",
    "created_at": "2023-10-16T08:45:26.241Z",
    "updated_at": "2023-10-16T08:45:26.241Z",
  }
}

Authorizations

​
Authorization
string
header
required

The secret key from your Nango environment.

Body

application/json
​
unique_key
string
required

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

​
provider
string
required

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
object

Integration credentials schema for different authentication types.

​
integration_config
object

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

Successfully created an integration

​
data
object
required