For AI agents: markdown of this page — /docs-content-en/automation/triggers/list.md documentation index — /llms.txt

Automation trigger list

GET /v1/triggers

Returns automation triggers registered by the current OAuth application in your Bitrix24 account. Available only with an OAuth key and an active user session.

The generic filter parameter is not applied by this endpoint. By default, the API preserves the previous HTTP 200 response and data, adds Warning: 299 - "filter is not supported on this endpoint and was ignored", and records unsupported-filter use in the server log.

Examples

curl

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

JavaScript

javascript 
const res = await fetch('https://vibecode.bitrix24.com/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
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata Typearray DescriptionArray of triggers registered by the application
Fielddata[].NAME Typestring DescriptionDisplay name of the trigger
Fielddata[].CODE Typestring DescriptionTrigger 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
HTTP200 CodeWarning: 299 DescriptionThe filter is ignored by default; previous data is preserved and the warning is sent in the Warning header.
HTTP400 (strict mode only) CodeUNSUPPORTED_FILTER DescriptionThe server mode is disabled by default; until it is enabled, the endpoint preserves HTTP 200 and the previous data.
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeINVALID_API_KEY DescriptionThe key is not recognized — no such key exists on the platform
HTTP401 CodeTOKEN_MISSING DescriptionThe OAuth key has no active user session — Authorization: Bearer is missing
HTTP401 CodeTOKEN_EXPIRED DescriptionThe user session has expired — re-authorize via /v1/oauth/authorize
HTTP403 CodeSCOPE_DENIED DescriptionThe key is missing the crm scope
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access: OAuth application context is required
HTTP429 CodeRATE_LIMITED DescriptionRequest rate limit exceeded
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 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 in your Bitrix24 account.

See also