Read Community Posts

Overview

The Read Community Posts Snap retrieves community post records from your Zendesk instance, with filtering options by topic or post ID, and optional comment sideloading.

Each community post is emitted as a separate document on the output view. You can optionally filter posts by status using the Include filter by option, and sort results by various fields. 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 `$` notation.	Mapper
Output	This Snap has one document output view. Each community post is emitted as a separate document. When Include comments is selected, comment records for each post are included in the output document.	Mapper
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.


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 Community Posts`
Filter mode `Dropdown list`	Select the strategy for filtering the community posts to retrieve. `All Posts`: Select to retrieve all community posts in the Zendesk instance. `By Topic`: Select to retrieve all posts within a specific community topic. Requires the Topics field. `By Post ID`: Select to retrieve a single post by its Zendesk post ID. Requires the Post ID field. Default value: `All Posts` Example: `By Topic`
Post ID* `String/Expression`	Appears when Filter mode is `By Post ID`. Enter the numeric Zendesk community post ID of the post to retrieve. Default value: None Example: `360001234567`
Topics* `String/Expression/ Suggestion`	Appears when Filter mode is `By Topic`. Specify the community topic to filter posts by. Suggestions are populated from your Zendesk instance when the account is configured. Default value: None Example: `Feature Requests`
Include comments `Checkbox`	When selected, the Snap retrieves and includes comment records for each community post in the output document. Default value: `Not selected`
Include filter by `Checkbox`	Appears when Filter mode is `By Topic`. When selected, the Filter by field appears, allowing you to restrict posts by their status. Default value: `Not selected`
Filter by `Dropdown list`	Appears when Include filter by is selected. Select a status to filter posts by their current status. Valid values: `planned`: Select to return only posts planned for implementation. `not_planned`: Select to return only posts that will not be implemented. `completed`: Select to return only posts whose request has been completed. `answered`: Select to return only posts that have been answered (question posts). `none`: Select to return only posts with no status set. Default value: `completed` Example: `answered`
Sort by `Dropdown list`	Select the field to sort results by. Valid values: `Updated At`: Sort by the date the post was last updated. `Created At`: Sort by the date the post was created. `Vote Sum`: Sort by the net number of votes on the post. `Comment Count`: Sort by the number of comments on the post. Default value: `Updated At` Example: `Created At`
Sort order `Dropdown list`	Select the direction in which to sort results. `Ascending`: Earliest to latest, lowest to highest. `Descending`: Latest to earliest, highest to lowest. Default value: `Descending` Example: `Ascending`
Max results `Integer/Expression`	Specify the maximum number of community post 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 `Retry-After` header, overriding the Retry interval value. On a 401 response, the Snap reloads the account credentials and retries before counting the attempt against this limit. 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: `Validate & Execute`: Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime. `Execute only`: Performs full execution of the Snap during pipeline execution without generating preview data. `Disabled`: Disables the Snap and all Snaps that are downstream from it. 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.
`Post ID is required when filter mode is 'By Post ID'`	Filter mode is `By Post ID` and Post ID is empty, or evaluates to `0`.	Enter a value in Post ID.
`Topic ID is required when filter mode is 'By Topic'`	Filter mode is `By Topic` and Topics is empty.	Enter a value in Topics.
`Topic '<name>' not found`	The value in Topics does not match any topic in your Zendesk instance.	Select the topic from the suggestions list, or verify that the value matches a topic in your Zendesk instance exactly.