Upsert Custom Object Record

zendesk/upsert-custom-object-record — Create or update a custom object record by external ID or name.

Where it appears

The Upsert 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 create or update a record for (e.g. `home_delivery_order`). Accepts literal text or <StepName.field>.
`name`	text (supports references)	No	—	Display name for the record; also used as the match key when it is unique. Accepts literal text or <StepName.field>.
`externalId`	text (supports references)	No	—	External identifier used as the match key to find an existing record; if none matches, a new record is created. Accepts literal text or <StepName.field>.
`customFields`	code	No	—	JSON object of custom object field keys to values to set on the created or updated record.

Inputs and outputs

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

Outputs

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

Name	Type	Description
`success`	boolean	Success status
`record`	json	Created or updated 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/upsert-custom-object-record",
  "config": {
    "customObjectKey": "<PreviousStep.field>"
  }
}

Limits and failure modes

Requires a connected Zendesk integration. Calls fail if that integration is disconnected or its authorization has expired.
Required field (customObjectKey) 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.