StyloDocs
Workflow blocks

Create User

Create a new Zendesk user

View as Markdown

zendesk/create-user — Create a new Zendesk user.

Where it appears

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

Fields

FieldTypeRequiredDefaultDescription
nametext (supports references)YesDisplay name for the new Zendesk user. Use literal text or <StepName.field> to reference a value from a previous step.
emailtext (supports references)YesPrimary email address for the new user; used as the identity for matching. Accepts literal text or <StepName.field>.
phonetext (supports references)NoOptional phone number to attach to the user. Accepts literal text or <StepName.field>.
roleselectNoZendesk role for the new user. End users are customers; agents and admins are staff with access to the agent interface. Options: end-user, agent, admin.
tagstext (supports references)NoOptional comma-separated tags to apply to the new user. 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 <Create User.field>.

NameTypeDescription
successbooleanSuccess status
userjsonCreated user
errorstringError message if failed

Example

A minimal configuration for this block:

{
  "type": "zendesk/create-user",
  "config": {
    "name": "<PreviousStep.field>",
    "email": "<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 (name, email) 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