#Automation trigger list

GET /v1/triggers

Returns automation triggers registered by the current OAuth application on the portal. Available only with an OAuth key and an active user session.

#Examples

#curl

Terminal 
curl https://vibecode.bitrix24.tech/v1/triggers \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/triggers', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()
console.log('Triggers:', data)

#Response fields

Field Type Description
success boolean true on success
data array Array of triggers registered by the application
data[].NAME string Display name of the trigger
data[].CODE string Trigger code — passed as triggerId to POST /v1/triggers/fire

#Response example

JSON 
{
  "success": true,
  "data": [
    {
      "NAME": "Payment received",
      "CODE": "payment_received"
    },
    {
      "NAME": "Delivery confirmed",
      "CODE": "delivery_confirmed"
    }
  ]
}

#Error response example

403 — request with a personal key: application context is not set:

JSON 
{
  "success": false,
  "error": {
    "code": "BITRIX_ACCESS_DENIED",
    "message": "Access denied! Application context required"
  }
}

#Errors

HTTP Code Description
401 MISSING_API_KEY The X-Api-Key header is missing
401 INVALID_API_KEY Invalid or expired API key
401 TOKEN_MISSING The OAuth key has no active user session — Authorization: Bearer is missing
401 TOKEN_EXPIRED The user session has expired — re-authorize via /v1/oauth/authorize
403 SCOPE_DENIED The key is missing the crm scope
403 BITRIX_ACCESS_DENIED Bitrix24 denied access: OAuth application context is required
429 RATE_LIMITED Request rate limit exceeded
502 BITRIX_UNAVAILABLE Bitrix24 is unavailable

Full list of common API errors — Errors.

#Known specifics

  • OAuth applications only. A request with a personal key (vibe_api_*) returns 403 BITRIX_ACCESS_DENIED — Bitrix24 requires the context of an installed OAuth application. To retrieve the trigger list, set up an OAuth application and obtain a user token via /v1/oauth/authorize.
  • Only the current application's triggers. The response contains triggers registered by the calling OAuth application itself, not all triggers on the portal.

#See also