ZendeskSettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Zendesk connection the step signs in with. |
| Subject | Leave empty and Zendesk uses the first line of the comment. |
| First commentRequired | Zendesk collapses runs of spaces and newlines in plain text, and silently cuts a comment off past 64 kB. |
| Comment format | "text" or "html" |
| Visible to the customer | Off writes an internal note only agents see. |
| Requester e-mail | Zendesk creates the end-user if this address is new. |
| Requester name | text |
| Requester id | Use instead of the e-mail when you already have the user id. |
| Assignee id | text |
| Group id | The List groups node gives you the id. |
| Organization id | text |
| Type | "" or "problem" or "incident" or "question" or "task" |
| Priority | "" or "urgent" or "high" or "normal" or "low" |
| Status | "new" or "open" or "pending" or "hold" or "solved" |
| Tags | Comma-separated. |
| Custom fields | Zendesk keys a custom field by its numeric id, never by its title — the List ticket fields node gives you the ids and, for drop-downs, the option tags. |
| External id | Your own id for this ticket. Zendesk does not enforce it as unique, so it does not stop a second run creating a second ticket. |
| Due at | Only a ticket of type Task has a due date. |
| Ticket form id | text |
| Brand id | text |
| E-mail CCs | Needs CCs and followers switched on in Zendesk. |
| Attachment tokens | Comma-separated values from the Upload attachment node. One expires 60 minutes after the upload. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `zendesk`) |
subject | text |
body | text |
bodyFormat | "text" or "html", by default "text" |
public | true/false, by default true |
requesterEmail | text |
requesterName | textused when `requesterEmail` is not "" |
requesterId | text |
assigneeId | text |
groupId | text |
organizationId | text |
type | "" or "problem" or "incident" or "question" or "task" |
priority | "" or "urgent" or "high" or "normal" or "low" |
status | "new" or "open" or "pending" or "hold" or "solved", by default "new" |
tags | text |
customFields | object of text, by default {} |
externalId | text |
dueAt | text |
ticketFormId | text |
brandId | text |
emailCcs | text |
uploadTokens | text |
Output
| Field | Type |
|---|---|
ticketId | string |
ticket | object |
ticketUrlAddress of the ticket in Zendesk | string |
requesterId | string |
Sample output, and the expression for each field
- requesterId"7"
- ticket
- id42
- subject"Printer is jammed"
- ticketId"42"
- ticketUrl"https://acme.zendesk.com/agent/tickets/42"
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"assigneeId": "",
"body": "<first comment>",
"bodyFormat": "text",
"brandId": "",
"connection": "<connection id>",
"customFields": {},
"dueAt": "",
"emailCcs": "",
"externalId": "",
"groupId": "",
"organizationId": "",
"priority": "",
"public": true,
"requesterEmail": "",
"requesterId": "",
"requesterName": "",
"status": "new",
"subject": "",
"tags": "",
"ticketFormId": "",
"type": "",
"uploadTokens": ""
},
"label": "Create ticket",
"type": "zendesk.createTicket",
"version": 1
}