Trigger Integration

Create Trigger integration

post/integration/trigger/create

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/trigger/create
  • Auth: HTTP bearer

Request body

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

blueprintIdstring nullable

The ID of the blueprint

botIdstring nullable

The ID of the bot this configuration is using

authenticateboolean

When enabled the integration requires authentication

schedulestring nullable

The schedule for the trigger integration (interval, cron expression, or ISO date)

timezonestring nullable

An optional IANA timezone identifier used when evaluating the trigger schedule.

sessionDurationnumber

The session duration (in milliseconds)

Example request

{
  "timezone": "America/New_York"
}

Response

The Trigger integration was created successfully

idstring required

The ID of the Trigger Integration

Changes

No recorded changes to this operation across all 1 revision of this API.