Read Sections
Overview
The Read Sections Snap retrieves Help Center section records from your Zendesk instance, filtered either by section or by category.
Each section is emitted as a separate document on the output view. Sections are the containers that group Help Center articles within a category. Use the Filter mode field to choose whether to retrieve sections by section or by category. Use the Max results field to limit the number of documents emitted.

- This is a Read-type Snap.
Works in Ultra Tasks
Supported Accounts
Prerequisites
None.
Snap views
| Type | Description | Examples of upstream and downstream Snaps |
|---|---|---|
| Input |
This Snap has at most one document input view. When connected, field values from the incoming document can be referenced
in expression-enabled fields using the |
|
| Output |
This Snap has one document output view. Each section is emitted as a separate document. |
|
| Learn more about Error handling. | ||
Snap settings
| Field/Field set | Description |
|---|---|
Label* String |
Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline. Default value: Read Sections |
Filter mode
Dropdown list |
Choose the strategy for selecting the sections to retrieve.
Default value: By Section Example: By Category |
Category*
Integer/Expression |
Enter the numeric Zendesk category ID whose sections you want to retrieve. Activates when Filter mode is By Category. Default value: None Example: 360001234567 |
Section
Integer/Expression |
Enter the numeric Zendesk section ID to retrieve a single specific section. Leave empty to retrieve all sections in the Zendesk instance. Activates when Filter mode is By Section. Default value: None Example: 360009876543 |
Locale
String/Expression |
Enter the locale code to restrict the retrieved sections to that locale. Leave empty to return sections in all locales. Default value: en-us Example: fr |
Sort by
Dropdown list |
Choose the field to sort the retrieved sections by.
Default value: Position Example: Updated At |
Sort order
Dropdown list |
Choose the direction in which to sort the retrieved sections.
Default value: Descending Example: Ascending |
Max results
Integer/Expression |
Specify the maximum number of section records to emit per execution. Enter 0 or leave empty to emit all matching results. Default value: 0 Example: 10 |
Retry attempts
Integer/Expression |
Enter the number of times the Snap should
retry the API call on connection errors or 5xx responses. On a 429 response,
the Snap automatically retries after the interval specified in the server's
Default value: 5 Example: 3 |
Retry interval (seconds)
Integer/Expression |
Enter the number of seconds to wait between retry attempts. Default value: 3 Example: 5 |
|
Snap execution Dropdown list
|
Choose one of the three modes in
which the Snap executes. Available options are:
Default value: Validate & execute |
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
| Unable to connect to Zendesk: <details> | The Snap could not connect to your Zendesk instance with the selected account, because of an authentication or network problem. | Verify the subdomain and credentials in the account, and that the Snaplex can reach your Zendesk instance. Then run the pipeline again. |
| Authentication failed. | Zendesk rejected the account credentials with HTTP 401 (Unauthorized). | Verify the credentials in the account, then run the pipeline again. |
| Invalid request. | Zendesk rejected the request with HTTP 400 (Bad Request) or HTTP 422
(Unprocessable Entity). The reason field in the error document
shows which. |
Review the Snap settings and the values in the input document, correct any value that Zendesk does not accept, and run the pipeline again. |
| Access denied. | Zendesk returned HTTP 403 (Forbidden). The Zendesk user behind the account does not have permission for the requested resource. | Use an account whose Zendesk user has at least the Agent role, or the permissions the operation requires. |
| Resource not found. | Zendesk returned HTTP 404 (Not Found). The ID in the Snap settings or input document does not exist in your Zendesk instance, or the record was deleted. | Verify the ID, and make sure the record still exists in Zendesk. |
| Rate limit exceeded. | Zendesk returned HTTP 429 (Too Many Requests), and the rate limit was still exceeded after the Snap's automatic retries. | Reduce the volume of requests, for example by retrieving fewer records per run, or schedule the pipeline outside peak hours. |
| Zendesk server error. | Zendesk returned HTTP 500, 502, 503, or 504, and the error persisted after the configured retries. | Wait a few minutes and run the pipeline again. If the error recurs, increase Retry attempts or Retry interval (seconds). |
| Network error while calling Zendesk. | The Snap could not reach Zendesk, for example because of a connection timeout or a DNS failure. | Verify that the Snaplex can reach your Zendesk instance, then run the pipeline again. |
| The <field> provided is not valid | An ID field, such as User ID or Ticket ID, received a value that is not a whole number. Zendesk ID fields accept integer values only. | Enter the numeric Zendesk ID, or fix the expression so that it evaluates to one. |