Workflow blocks
Set Lookup Field
Set a lookup relationship field on a ticket to a custom object record by ID, name, or external ID
zendesk/set-lookup-field — Set a lookup relationship field on a ticket to a custom object record by ID, name, or external ID.
Where it appears
The Set Lookup Field block lives in the Integrations group of the Workflow Builder. Connect the Zendesk integration before adding it.
Fields
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId | text (supports references) | Yes | — | Numeric Zendesk ticket ID whose lookup field should be set. Use a literal number or <StepName.field> to reference an ID from a previous step. |
fieldId | text (supports references) | Yes | — | Numeric ID of the lookup-relationship ticket field to set. Use a literal ID or <StepName.field>. |
lookupValue | text (supports references) | Yes | — | Identifies the custom object record to link: a record ID, or name:VALUE / external_id:VALUE to match by name or external ID. Accepts literal text or <StepName.field>. |
Inputs and outputs
Inputs are the configurable fields above. The block produces these outputs:
Outputs
Reference an output downstream with <Set Lookup Field.field>.
| Name | Type | Description |
|---|---|---|
success | boolean | Success status |
ticket | json | Updated ticket (object — fields: id, subject, description, status, priority, type, tags, requester_id, assignee_id, group_id, custom_fields, created_at, updated_at) |
error | string | Error message if failed |
Example
A minimal configuration for this block:
{
"type": "zendesk/set-lookup-field",
"config": {
"ticketId": "<PreviousStep.field>",
"fieldId": "<PreviousStep.field>",
"lookupValue": "<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,fieldId,lookupValue) must be set, or the block fails validation before it runs. - On failure the
erroroutput is populated; downstream blocks that reference other outputs may not receive values.