Deskhero Developer Hub
Back to deskhero.com
Automations

Create

Creates an automation rule, always of type CUSTOM and always placed first in the execution order, so it runs before every existing rule. Conditions and actions are validated against the fields, Users, groups and list entries they reference, and creation fails when the tenant plan's automation rule quota is reached.

POST /api/{tenant:minlength(2)}/v{version:apiVersion}/automations
Authorisation
Minimum role: ADMIN

Request arguments

Name Type Source
inputDTO_automationBody
Request body example

Response

Status
200 (OK)
Type
DTO_automation
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 403 (Forbidden)
Response body example
DTO_automation
NameTypeReadOnlyDescription
condition_groupsDTO_automation_condition_group[]Condition groups
actionsDTO_automation_action[]Actions
created_byDTO_reference_userCreated by
last_updated_byDTO_reference_userLast updated by
idInt32ReadOnlyLeave empty on input
nameStringName
trigger_byENUM automation_trigger_byTrigger by
condition_groups_operatorENUM automation_conditions_operatorCondition groups operator
automation_typeENUM automation_typeAutomation type
execution_orderStringReadOnlyExecution order
enabledBooleanEnabled
createdDateTimeReadOnlyCreated
last_updatedDateTimeReadOnlyLast updated
DTO_automation_condition_group
NameTypeReadOnlyDescription
conditionsDTO_automation_condition[]Conditions
idInt32ReadOnlyId
conditions_operatorENUM automation_conditions_operatorConditions operator
DTO_automation_condition
NameTypeReadOnlyDescription
valuesDTO_automation_value[]Values
idInt32ReadOnlyId
field_keyStringField key
condition_typeENUM automation_condition_typeCondition type
DTO_automation_value
NameTypeReadOnlyDescription
idInt32The id of the reference
labelObjectLabel
DTO_automation_action
NameTypeReadOnlyDescription
valueDTO_automation_valueDeprecated in favour of , but still read on input and always populated on output (with the first entry of ) so existing API clients keep working.
valuesDTO_automation_value[]All values the action sets. Only fields that accept several values at once - tags and PICK_MANY custom fields - may hold more than one entry; every other field is limited to a single value.
field_keyStringField key
action_typeENUM automation_action_typeAction type
DTO_reference_user
NameTypeReadOnlyDescription
profile_picStringReadOnlyProfile pic
emailStringReadOnlyEmail
idInt32Id
labelObjectReadOnlyLabel
ENUM automation_conditions_operator
ValueNameDescription
0UNKNOWNUNKNOWN
1ANDAND
2OROR
ENUM automation_condition_type
ValueNameDescription
0UNKNOWNUNKNOWN
1CONTAINSContains
2NOT_CONTAINSDoesn't contain
3EQUALEquals
4NOT_EQUALNot equal
5CHANGED_TO_EQUALOnly for update triggers
6CHANGED_TO_NOT_EQUALOnly for update triggers
7AI_EVALUATEDOnly for create trigger in combination with specific "any" key
ENUM automation_action_type
ValueNameDescription
0UNKNOWNUNKNOWN
1SET_VALUESet value
2SET_SLASet SLA
3SEND_NOTIFICATIONSend notification
ENUM automation_trigger_by
ValueNameDescription
0UNKNOWNUNKNOWN
1TICKET_NEWNew ticket
2TICKET_UPDATETicket update
2TICKET_SLA_BREACHTicket update
ENUM automation_type
ValueNameDescription
0UNKNOWNUNKNOWN
1SYS_LOCKED_SETTINGSOnly the values can be changed
2CUSTOMCustom

Generated Aug 4, 2026 18:37