POST
/
v1
/
chat
/
integrations
/
configure
cURL
curl --request POST \
  --url https://api.botpress.cloud/v1/chat/integrations/configure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-bot-id: <api-key>' \
  --data '{
  "identifier": "<string>",
  "scheduleRegisterCall": "hourly",
  "sandboxIdentifiers": {}
}'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
x-bot-id
string
header
required

Your bot ID.

Body

application/json

Configuration of the integration

​
identifier
string

Unique identifier of the integration that was installed on the bot

Maximum length: 200
​
scheduleRegisterCall
enum<string>

Recurring schedule on which register() will be called on the integration

Available options:
hourly,
daily,
weekly,
bi-weekly,
monthly,
bi-monthly,
quarterly,
yearly
​
sandboxIdentifiers
object | null

Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. Setting an individual sandbox identifier to null will remove that sandbox identifier. This is an experimental feature meant to be used by specific integrations.

Response

200
application/json

Configuration of the integration

The response is of type object.