Ticket automations
`/ticket-automations` - read-only
One page of records, newest first unless you say otherwise, with the total count in meta so you know how far to paginate.
Required scope: ticket-automations:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
page?integer1-based. meta.totalPages says how many there are.
1 <= value1per_page?integerRows per page. A value above 200 returns 400 - never a silent clamp.
1 <= value <= 20050sort?stringPrefix with - for descending. An undeclared sort returns 400.
"position""position""-position""createdAt""-createdAt""name""-name"q?stringCase-insensitive "contains", across: name.
filter[trigger]?stringExact match on trigger.
filter[active]?stringExact match on active.
"true""false"The requested page.
application/json- response
data*array<>meta*curl -X GET 'https://api.usedashly.com/v1/ticket-automations'{ "data": [ { "id": "string", "name": "string", "active": true, "trigger": "string", "position": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "meta": { "page": 0, "perPage": 0, "total": 0, "totalPages": 0 }}The full record, custom fields included when the resource carries them. A record from another agency is a 404, not a 403 - its existence is not ours to confirm.
Required scope: ticket-automations:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.
Found.
application/json- response
data*curl -X GET 'https://api.usedashly.com/v1/ticket-automations/string'{ "data": { "id": "string", "name": "string", "active": true, "trigger": "string", "position": 0, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}Every verb this resource answers to, with its target and the JSON Schema of its body - the same contracts this document describes, readable at runtime.
Required scope: ticket-automations:read.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
The available verbs.
application/json- response
data*array<>curl -X GET 'https://api.usedashly.com/v1/ticket-automations/actions'{ "data": [ { "name": "string", "label": "string", "description": "string", "target": "item", "readOnly": true, "path": "string", "input": {} } ]}Creates a "when X then Y" rule on tickets: a trigger, conditions (category values by public id) and actions (category and template by public id). 50 rules maximum per agency.
Does what the dashboard's createAutomationAction does - same implementation, so the two cannot diverge.
Required scope: ticket-automations:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
name*string1 <= length <= 80trigger*string"ticket.created""ticket.status_changed""ticket.assigned""ticket.priority_changed""ticket.comment_added""ticket.custom_field_changed""ticket.due_date_passed""github.pr_merged"conditions?array<|>items <= 10[]actions*array<|||||||>1 <= items <= 5active?booleantrueDone.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/ticket-automations/actions/create' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "trigger": "ticket.created", "actions": [ { "type": "set_status", "status": "string" } ]}'{ "data": null}Replaces the rule wholesale - name, trigger, conditions, actions, enabled state. The same contract as creation, exactly as in the dashboard.
Does what the dashboard's updateAutomationAction does - same implementation, so the two cannot diverge.
Required scope: ticket-automations:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
name*string1 <= length <= 80trigger*string"ticket.created""ticket.status_changed""ticket.assigned""ticket.priority_changed""ticket.comment_added""ticket.custom_field_changed""ticket.due_date_passed""github.pr_merged"conditions?array<|>items <= 10[]actions*array<|||||||>1 <= items <= 5active?booleantrueDone.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/ticket-automations/string/actions/update' \ -H 'Content-Type: application/json' \ -d '{ "name": "string", "trigger": "ticket.created", "actions": [ { "type": "set_status", "status": "string" } ]}'{ "data": null}Enables (active: true) or pauses (active: false) the rule without otherwise changing it.
Does what the dashboard's toggleAutomationAction does - same implementation, so the two cannot diverge.
Required scope: ticket-automations:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
active*booleanDone.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/ticket-automations/string/actions/toggle' \ -H 'Content-Type: application/json' \ -d '{ "active": true}'{ "data": null}Permanently deletes the rule and its run log. The collection is read-only, so deletion goes through this verb.
Does what the dashboard's deleteAutomationAction does - same implementation, so the two cannot diverge. Takes no body.
Required scope: ticket-automations:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255Done.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/ticket-automations/string/actions/delete'{ "data": null}Creates an inactive rule called "Nouvelle règle", triggered when a ticket is created and setting the first column of the agency's workflow. Returns its id so you can configure it next. 50 rules maximum per agency.
Does what the dashboard's createDraftAutomationAction does - same implementation, so the two cannot diverge. Takes no body.
Required scope: ticket-automations:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255Done.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/ticket-automations/actions/create-draft'{ "data": null}Replaces the rule's tags with exactly this list (ids from /v1/automation-tags). An empty list removes them all.
Does what the dashboard's setRuleTagsAction does - same implementation, so the two cannot diverge.
Required scope: ticket-automations:write.
bearerAuthAuthorizationBearer <token>Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.
id*stringThe public id of the record to act on. It is resolved inside your agency before the action runs, so an id from another tenant is a 404 and never reaches it.
Idempotency-Key?stringA value you choose (a UUID is the usual one), 8 to 255 characters of A-Z a-z 0-9 _ . : -. Retrying with the same key returns the first call's answer instead of creating a second record, for seven days. The same key with a different body returns 409.
8 <= length <= 255application/json- body
tagIds*array<>items <= 20Done.
application/json- response
data*unknownThe action's result; its shape depends on the verb.
curl -X POST 'https://api.usedashly.com/v1/ticket-automations/string/actions/set-tags' \ -H 'Content-Type: application/json' \ -d '{ "tagIds": [ "string" ]}'{ "data": null}