StyloDocs
Workflow blocks

Apply Macro

Apply a predefined macro to a ticket

View as Markdown

zendesk/apply-macro — Apply a predefined macro to a ticket.

Where it appears

The Apply Macro block lives in the Integrations group of the Workflow Builder. Connect the Zendesk integration before adding it.

Fields

FieldTypeRequiredDefaultDescription
ticketIdtext (supports references)YesNumeric Zendesk ticket ID to apply the macro to. Use a literal number or <StepName.field> to reference an ID from a previous step.
macroIdtext (supports references)YesNumeric Zendesk macro ID whose actions should be applied to the ticket. Use a literal ID or <StepName.field>.

Inputs and outputs

Inputs are the configurable fields above. The block produces these outputs:

Outputs

Reference an output downstream with <Apply Macro.field>.

NameTypeDescription
successbooleanSuccess status
ticketjsonUpdated ticket (object — fields: id, subject, description, status, priority, type, tags, requester_id, assignee_id, group_id, custom_fields, created_at, updated_at)
errorstringError message if failed

Example

A minimal configuration for this block:

{
  "type": "zendesk/apply-macro",
  "config": {
    "ticketId": "<PreviousStep.field>",
    "macroId": "<PreviousStep.field>"
  }
}

Limits and failure modes

  • Requires a connected Zendesk integration. Calls fail if that integration is disconnected or its authorization has expired.
  • Required fields (ticketId, macroId) must be set, or the block fails validation before it runs.
  • On failure the error output is populated; downstream blocks that reference other outputs may not receive values.

On this page