Fire Trigger Event

Fire a proactive trigger event for an agent (public, no auth required, rate limited to 60 req/min)

POST /v1/bot/trigger

Fire Trigger Event

cURL

curl --request POST \
  --url https://api.boostgpt.co/v1/bot/trigger \
  --header 'Content-Type: application/json' \
  --data '
{
  "bot_id": "<string>",
  "event": "<string>",
  "context": {},
  "source_url": "<string>",
  "user": {
    "name": "<string>",
    "email": "<string>",
    "id": "<string>"
  },
  "screenshot": "<string>"
}
'

200

{
  "success": true,
  "chat_id": "<string>",
  "chat_url": "<string>",
  "event": "<string>"
}

Body

application/json

bot_id · string · required

Agent ID

event · string · required

Event name (e.g., 'checkout_error')

context · object

Custom context key-value pairs

source_url · string

Page URL where trigger fired

user · object

User information

Show child attributes

screenshot · string

Base64 data URL of page screenshot (max 5MB)

Response

200

application/json

Trigger fired successfully

success · boolean

chat_id · string

Chat session UUID

chat_url · string

URL to chat interface

event · string

Event name