Skip to main content
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: <x-bot-id>' \
  --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.

Headers

​
x-bot-id
string
required

Bot id

​
x-integration-id
string

Integration id

​
x-integration-alias
string

Integration alias

Body

application/json

Configuration of the integration

​
identifier
string | null

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

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

Response

Configuration of the integration

The response is of type object.