ByteChef LogoByteChef
Backend (API Key)Integration Instances

Connect and configure an integration instance to an existing integration

Connects an integration instance to an existing integration, allowing access to its functionality and resources.

POST
/{externalUserId}/integrations/{id}/instances

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

externalUserId*string

The external user id.

id*integer

The id of an integration.

Formatint64

Header Parameters

X-Environment?string

The environment.

Value in

  • "DEVELOPMENT"
  • "STAGING"
  • "PRODUCTION"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/string/integrations/0/instances" \  -H "Content-Type: application/json" \  -d '{    "connection": {}  }'
0

How is this guide?

Embedded Integration Instances

Create and delete a connected user's instance of an integration.

Delete an integration instance DELETE

Delete an integration instance.