Trigger Integration

Fetch a triggerIntegration

get/integration/trigger/{triggerIntegrationId}/fetch

Request

  • Base URL: https://api.chatbotkit.com/api/v1
  • URL: https://api.chatbotkit.com/api/v1/integration/trigger/{triggerIntegrationId}/fetch
  • Auth: HTTP bearer

Path parameters

triggerIntegrationIdstring required

The ID of the Trigger integration to retrieve

Response

The Trigger integration was retrieved successfully

aliasstring nullable

The unique alias for the instance

namestring

The associated name

descriptionstring

The associated description

metaMeta

Meta data information

idstring required

The instance ID

createdAtnumber required

The timestamp (ms) when the instance was created

updatedAtnumber required

The timestamp (ms) when the instance was updated

blueprintIdstring nullable

The ID of the blueprint

botIdstring nullable

The ID of the bot this configuration is using

secretstring required

The Trigger integration secret (returned in clear to the owner - it is the value the calling system must present)

authenticateboolean

When enabled the integration requires authentication

schedulestring nullable

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

timezonestring nullable

The IANA timezone identifier used to evaluate the trigger schedule.

sessionDurationnumber

The session duration (in milliseconds)

lastTriggerAtnumber nullable

The timestamp (ms) of the last trigger execution

nextTriggerAtnumber nullable

The timestamp (ms) of the next scheduled trigger execution

Changes

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