Create Custom Object Record

zendesk/create-custom-object-record — Create a new custom object record.

Where it appears

The Create 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 a record for (e.g. `home_delivery_order`). Accepts literal text or <StepName.field>.
`name`	text (supports references)	No	—	Optional display name for the new record. Accepts literal text or <StepName.field>.
`externalId`	text (supports references)	No	—	Optional external identifier to associate with the record for cross-system matching. Accepts literal text or <StepName.field>.
`customFields`	code	No	—	JSON object of custom object field keys to values for the new record (e.g. `{ "field_key": "value" }`).

Inputs and outputs

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

Outputs

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

Name	Type	Description
`success`	boolean	Success status
`record`	json	Created 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/create-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.