Create a localized trigger
Creates a proactive chat trigger for the authenticated organization.
/api/triggersCreates 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 keyorX-API-Key header. - Required scope
triggers:write- 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
- 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.
Header Parameters
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).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "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"}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?