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.
  • Does not support 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.
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.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description

Label

String

Required. 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