Define a reusable list of ticket actions, manual or triggered
Define an ordered list of actions that can be applied to a ticket.
/v1/macrosEditor- Operation id
- create_macro
- Access
- A viewer is refused.
/v1/macrosDefine an ordered list of actions that can be applied to a ticket.
Omit trigger (or send null) for a manual-only macro, which is the default
and can only be run through POST /v1/macros/{macro_id}/apply/{ticket_id}.
Supply a trigger to have it fire automatically on ticket create, ticket
update, or both, for tickets matching its conditions.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: editor, admin or owner. A viewer receives 403 insufficient_role.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the helpdesk-ops:write scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/macros" \ -H "Content-Type: application/json" \ -d '{ "name": "Refund issued", "actions": [ { "body": "Your refund is on its way.", "kind": "reply" }, { "kind": "set_status", "value": "solved" } ] }'{}