POST/api/triggers

Creates a proactive chat trigger for the authenticated organization. Conditions must match the selected trigger type. Every translation locale must be enabled for the organization, and the default locale needs a published message. The plan's trigger limit applies. The trigger can match new visitor sessions as soon as the request succeeds.

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: triggers:write
Module: Automation & API module (automation_api)
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: Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body accepted by this operation.

Response Body

`application/json`

{
  "id": "0f02f960-1ac6-4b1d-a760-326a4687674c",
  "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",
  "name": "Offer help after 30 seconds",
  "type": "time_on_page",
  "conditions": {
    "seconds": "example"
  },
  "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"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "correlationId": "req_01K0MANAGEMENT401"
  }
}

{
  "error": {
    "code": "INTEGRATION_MODULE_REQUIRED",
    "message": "The automation API module is required.",
    "details": {
      "module": "automation_api",
      "feature": "public_api"
    },
    "correlationId": "req_01K0MANAGEMENT402"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "The caller lacks the required role or API-key scope.",
    "correlationId": "req_01K0MANAGEMENT403"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource was not found.",
    "correlationId": "req_01K0MANAGEMENT404"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "The requested change conflicts with current resource state.",
    "correlationId": "req_01K0MANAGEMENT409"
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request payload is invalid.",
    "details": {
      "field": "name"
    },
    "correlationId": "req_01K0MANAGEMENT422"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests.",
    "correlationId": "req_01K0MANAGEMENT429"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request POST \
  'https://api.convor.io/api/triggers' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Offer help after 30 seconds",
  "type": "time_on_page",
  "conditions": {},
  "description": "Shown on pricing pages after a short delay.",
  "translations": [
    {
      "locale": "en",
      "status": "published",
      "message": "Do you need help choosing a plan?",
      "ctaLabel": "Start chat"
    }
  ],
  "isActive": true
}'

JavaScript

const response = await fetch("https://api.convor.io/api/triggers", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_...",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "Offer help after 30 seconds",
    "type": "time_on_page",
    "conditions": {},
    "description": "Shown on pricing pages after a short delay.",
    "translations": [
      {
        "locale": "en",
        "status": "published",
        "message": "Do you need help choosing a plan?",
        "ctaLabel": "Start chat"
      }
    ],
    "isActive": true
  }),
});

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?

Create a localized trigger

Creates a proactive chat trigger for the authenticated organization.

POST/api/triggers

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: triggers:write
Module: Automation & API module (automation_api)
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: Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body accepted by this operation.

name*string

Human-readable name.

type*string

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

conditions*

Conditions that determine when this rule matches.

description?string

Human-readable description.

translations*array<>

Localized variants for this resource.

isActive?boolean

Whether the resource is active.

Response Body

`application/json`

{
  "id": "0f02f960-1ac6-4b1d-a760-326a4687674c",
  "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",
  "name": "Offer help after 30 seconds",
  "type": "time_on_page",
  "conditions": {
    "seconds": "example"
  },
  "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"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "correlationId": "req_01K0MANAGEMENT401"
  }
}

{
  "error": {
    "code": "INTEGRATION_MODULE_REQUIRED",
    "message": "The automation API module is required.",
    "details": {
      "module": "automation_api",
      "feature": "public_api"
    },
    "correlationId": "req_01K0MANAGEMENT402"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "The caller lacks the required role or API-key scope.",
    "correlationId": "req_01K0MANAGEMENT403"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "The requested resource was not found.",
    "correlationId": "req_01K0MANAGEMENT404"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "The requested change conflicts with current resource state.",
    "correlationId": "req_01K0MANAGEMENT409"
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request payload is invalid.",
    "details": {
      "field": "name"
    },
    "correlationId": "req_01K0MANAGEMENT422"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests.",
    "correlationId": "req_01K0MANAGEMENT429"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request POST \
  'https://api.convor.io/api/triggers' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Offer help after 30 seconds",
  "type": "time_on_page",
  "conditions": {},
  "description": "Shown on pricing pages after a short delay.",
  "translations": [
    {
      "locale": "en",
      "status": "published",
      "message": "Do you need help choosing a plan?",
      "ctaLabel": "Start chat"
    }
  ],
  "isActive": true
}'

JavaScript

const response = await fetch("https://api.convor.io/api/triggers", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_...",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "Offer help after 30 seconds",
    "type": "time_on_page",
    "conditions": {},
    "description": "Shown on pricing pages after a short delay.",
    "translations": [
      {
        "locale": "en",
        "status": "published",
        "message": "Do you need help choosing a plan?",
        "ctaLabel": "Start chat"
      }
    ],
    "isActive": true
  }),
});

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?

Create a localized trigger

Endpoint requirements

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Create a localized trigger

Endpoint requirements

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Create a localized trigger

Endpoint requirements

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

Create a localized trigger

Endpoint requirements

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`