Get Custom Object Record

zendesk/get-custom-object-record — Fetch a Zendesk custom object record by ID.

Where it appears

The Get Custom Object Record block lives in the Integrations group of the Workflow Builder. Connect the Zendesk integration before adding it.

Fields

Field	Type	Required	Default	Description
`customObjectKey`	text (supports references)	Yes	—	The key of the Zendesk custom object type to read from (e.g. `home_delivery_order`). Accepts literal text or <StepName.field>.
`recordId`	text (supports references)	Yes	—	ID of the custom object record to fetch. Use a literal ID or <StepName.field> to reference an ID from a previous step.

Inputs and outputs

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

Outputs

Reference an output downstream with <Get Custom Object Record.field>.

Name	Type	Description
`success`	boolean	Success status
`record`	json	Custom object record (object — fields: `id`, `name`, `external_id`, `custom_object_key`, `custom_object_fields`, `created_at`, `updated_at`)
`error`	string	Error message if failed

Example

A minimal configuration for this block:

{
  "type": "zendesk/get-custom-object-record",
  "config": {
    "customObjectKey": "<PreviousStep.field>",
    "recordId": "<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 (customObjectKey, recordId) 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.