ZendeskSettings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Zendesk connection the step signs in with. |
| Ticket idRequired | text |
| Order | "created_at" or "-created_at" |
| Also fetch the authors | A comment names its author by id only — this returns the people beside it. |
| Also fetch images placed in the text | true/false |
| Comments per call | 1 to 100. |
| Fetch every page | Follows Zendesk's cursor, and refuses past 5,000 comments rather than answering a short list. A ticket holds at most 5,000. |
| Cursor | Paste a previous run's Next cursor to read the page after it. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `zendesk`) |
ticketId | text |
sort | "created_at" or "-created_at", by default "created_at" |
includeUsers | true/false, by default false |
includeInlineImages | true/false, by default false |
limit | number, by default 100 |
returnAll | true/false, by default false |
cursor | text |
Output
| Field | Type |
|---|---|
comments | array |
commentCountComments in this answer | number |
hasMoreMore comments are waiting behind this page | boolean |
nextCursorCursor for the next page | string |
usersThe authors | array |
Sample output, and the expression for each field
- commentCount0
- comments[]
- hasMorefalse
- nextCursor""
- users[]
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": {
"connection": "<connection id>",
"cursor": "",
"includeInlineImages": false,
"includeUsers": false,
"limit": 100,
"returnAll": false,
"sort": "created_at",
"ticketId": "<ticket id>"
},
"label": "List ticket comments",
"type": "zendesk.listComments",
"version": 2
}Older versions
A flow that already has this version keeps running it. A new step always gets the newest.
Version 1
| Setting | What it is |
|---|---|
| ConnectionRequired | The Zendesk connection the step signs in with. |
| Ticket idRequired | text |
| Order | "created_at" or "-created_at" |
| Also fetch the authors | A comment names its author by id only — this returns the people beside it. |
| Also fetch images placed in the text | true/false |
| Comments per call | 1 to 100. |
| Fetch every page | Follows Zendesk's cursor, and refuses past 5,000 comments rather than answering a short list. A ticket holds at most 5,000. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `zendesk`) |
ticketId | text |
sort | "created_at" or "-created_at", by default "created_at" |
includeUsers | true/false, by default false |
includeInlineImages | true/false, by default false |
limit | number, by default 100 |
returnAll | true/false, by default false |