BackendHTTP APIIntegrations

Get an integration

Requires an API key with one of: environment:integrations:read or environment:integrations:read_credentials. Learn more about API key scopes.

Response example

{
  "data": {
    "unique_key": "slack-nango-community",
    "display_name": "Slack",
    "provider": "slack",
    "logo": "http://localhost:3003/images/template-logos/github.svg",
    "forward_webhooks": true,
    "created_at": "2023-10-16T08:45:26.241Z",
    "updated_at": "2023-10-16T08:45:26.241Z"
  }
}

For providers that declare an integration_config schema, alongside or instead of fixed credential fields (e.g. aws-sigv4, epic, private-api-generic), credentials returns type: "INTEGRATION_CONFIG" with the provider's actual auth_mode and its integration_config values -- only the fields that provider's schema declares, nothing else from the integration's internal storage. Any integration_config field the provider's schema marks secret: true (e.g. aws-sigv4's awsAccessKeyId and awsSecretAccessKey) is masked as *** rather than echoed in cleartext, regardless of API key scope.

GET
/integrations/{uniqueKey}

Returns a specific integration

Authorization

bearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

uniqueKey*string

The integration ID (unique_key) that you created in Tenklo.

Query Parameters

include?array<>

Include additional sensitive data

Response Body

Successfully returned an integration

application/json
  1. response
data*
Example Request
curl -X GET 'https://api.tenklo.dev/integrations/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"    ],    "webhook_url": "string",    "credentials": {      "type": "OAUTH1",      "client_id": "string",      "client_secret": "string",      "scopes": "string",      "webhook_secret": "string"    }  }}