Preview draft rule matching
Evaluate unsaved conditions, channel and account availability, schedule and reply cooldown using the runtime rule planner.
/api/automation-rules/previewEvaluate unsaved conditions, channel and account availability, schedule and reply cooldown using the runtime rule planner. No messages are sent or changes persisted.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
automation-rules:read- Module
- Automation & API module (
api_access) - Organization and site scope
- single-project
- Retry behavior
- Safe read: You can safely retry this read-only request after a transport failure. It does not change resource state.
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
{ "matched": true, "replyEligible": true, "reason": "channel_scope"}Request examples
curl
curl --request POST \
'https://api.convor.io/api/automation-rules/preview' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"channels": [
"widget"
],
"accounts": {},
"conditions": {
"type": "all",
"conditions": [
{
"type": "conversation_event",
"value": "visitor_message"
}
]
},
"timing": {
"timezone": "Europe/Warsaw",
"startsAt": "2026-08-04T10:00:00.000Z",
"endsAt": "2026-08-04T10:00:00.000Z",
"schedule": null,
"cooldownHours": 1
},
"message": "Example customer-support message.",
"locale": "en",
"operatorAvailable": true,
"context": {
"event": "visitor_message",
"channel": "widget",
"accountId": "11111111-1111-4111-8111-111111111111",
"allegroKind": "COMMON",
"now": "2026-08-04T10:00:00.000Z",
"lastReplySentAt": "2026-08-04T10:00:00.000Z"
},
"responseEnabled": true
}'JavaScript
const response = await fetch("https://api.convor.io/api/automation-rules/preview", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"channels": [
"widget"
],
"accounts": {},
"conditions": {
"type": "all",
"conditions": [
{
"type": "conversation_event",
"value": "visitor_message"
}
]
},
"timing": {
"timezone": "Europe/Warsaw",
"startsAt": "2026-08-04T10:00:00.000Z",
"endsAt": "2026-08-04T10:00:00.000Z",
"schedule": null,
"cooldownHours": 1
},
"message": "Example customer-support message.",
"locale": "en",
"operatorAvailable": true,
"context": {
"event": "visitor_message",
"channel": "widget",
"accountId": "11111111-1111-4111-8111-111111111111",
"allegroKind": "COMMON",
"now": "2026-08-04T10:00:00.000Z",
"lastReplySentAt": "2026-08-04T10:00:00.000Z"
},
"responseEnabled": 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?