ByteChef LogoByteChef
Frontend (Signing Key JWT)Integration Instances

Create and configure an integration instance

Creates and configures a new integration instance that connects to the specified integration, providing access to its functionality and enabling integration with external services and systems.

POST
/integrations/{id}/instances

Authorization

jwtBearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

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/integrations/0/instances" \  -H "Content-Type: application/json" \  -d '{    "connection": {}  }'
0

How is this guide?

Embedded Integration Instances (Frontend)

Create and delete the signed-in connected user's instance of an integration.

Delete an integration instance DELETE

Delete an integration instance.