Creates one organization-scoped proactive chat trigger. Conditions are validated against the selected trigger type, every locale must be configured for the organization, and a published default-locale translation is required. The operation enforces the plan trigger limit and publishes the new configuration to runtime caches. Access requires an active organization administrator session or an organization API key with the `triggers:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.
/api/triggersOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
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",
"name": "Offer help after 30 seconds",
"type": "time_on_page",
"conditions": {
"seconds": 30
},
"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"
}
}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": {
"seconds": 30
},
"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 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": {
"seconds": 30
},
"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?
Triggers
Proactive message triggers
Delete a trigger
Permanently deletes one organization-owned trigger and its localized variants. The trigger-count cache, localization revision, and runtime trigger configuration are refreshed before the operation returns. Access requires an active organization administrator session or an organization API key with the `triggers:write` scope. API-key calls also require the automation API module. Data is isolated to the authenticated organization; identifiers from another organization or site are not disclosed.