Skip to content
Convor
Convor Docs
API ReferenceTriggers

List localized triggers

Returns proactive triggers for the authenticated organization, newest first.

GET/api/triggers

Returns proactive triggers for the authenticated organization, newest first. Filter by name, trigger type, or active state, then paginate with either page or offset. fireCount counts system messages emitted by each trigger during the previous 30 days. Localized content is resolved from the stored translations.

Endpoint requirements

Credentials
Use either Bearer API key or X-API-Key header.
Required scope
triggers:read
Module
Automation & API module (api_access)
Organization and site scope
Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior
Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.

Query Parameters

limit?integer

Maximum number of resources to return.

Range1 <= value <= 100
Default20
page?integer

One-based page number.

Range1 <= value <= 9007199254740991
offset?integer

Zero-based number of resources to skip.

Range0 <= value <= 9007199254740991
Default0
search?string

Query parameter. Search text.

type?string

Query parameter. Type. Allowed values: time_on_page, visited_page, exit_intent, first_visit, proactive_invitation.

Value in

  • "time_on_page"
  • "visited_page"
  • "exit_intent"
  • "first_visit"
  • "proactive_invitation"
isActive?boolean

Query parameter. Whether the resource is active.

sortBy?string

Query parameter. Sort by. Allowed values: name, type, fireCount, isActive, createdAt.

Default"createdAt"

Value in

  • "name"
  • "type"
  • "fireCount"
  • "isActive"
  • "createdAt"
sortDirection?string

Query parameter. Sort direction. Allowed values: asc, desc.

Default"desc"

Value in

  • "asc"
  • "desc"

Header Parameters

X-Project-Id?|

DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

{  "data": [    {      "id": "0f02f960-1ac6-4b1d-a760-326a4687674c",      "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",      "projectId": "11111111-1111-4111-8111-111111111111",      "name": "Offer help after 30 seconds",      "type": "time_on_page",      "conditions": {},      "description": "Shown on pricing pages after a short delay.",      "translations": [        {          "id": "0a1e5ab4-2477-40ca-a442-2d962ef5c151",          "locale": "en",          "status": "published",          "message": "Do you need help choosing a plan?",          "ctaLabel": "Start chat",          "sourceLocale": null,          "machineTranslatedAt": null,          "reviewedAt": null,          "reviewedBy": null,          "createdAt": "2026-08-03T18:00:00.000Z",          "updatedAt": "2026-08-03T18:00:00.000Z"        }      ],      "isActive": true,      "fireCount": 0,      "createdAt": "2026-08-03T18:00:00.000Z",      "updatedAt": "2026-08-03T18:00:00.000Z"    }  ],  "pagination": {    "totalItems": 1,    "page": 1,    "pageSize": 20,    "hasNextPage": false,    "hasPrevPage": false  },  "capacityCount": 1}

Request examples

curl

curl --request GET \
  'https://api.convor.io/api/triggers' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...'

JavaScript

const response = await fetch("https://api.convor.io/api/triggers", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_..."
  },
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Delete a trigger

Permanently deletes a trigger and all of its localized variants.

Update a localized trigger

Partially updates a trigger in the authenticated organization.

On this page

Request examplescurlJavaScript