BackendHTTP APIIntegrations

Update an integration

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

PATCH
/integrations/{uniqueKey}

Edit an 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.

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.

display_name?string

The integration display name.

forward_webhooks?boolean

Whether to forward webhooks received for this integration.

credentials?||||

Developer app credentials for the integration. Only the fields you pass are updated; the ones you leave out keep their current value.

integration_config?

Provider-specific configuration for providers that declare an integration_config schema (e.g. private-api-generic, aws-sigv4). Only the fields you pass are updated.

Response Body

Successfully updated an integration

application/json
  1. response
data*
Example Request
curl -X PATCH 'https://api.tenklo.dev/integrations/string' \  -H 'Content-Type: application/json' \  -d '{}'
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"    ]  }}