Read Community Topics

Overview

The Read Community Topics Snap retrieves community topic records from your Zendesk instance, with an optional filter by topic ID.

Each community topic is emitted as a separate document on the output view. Topics are the category containers that group community posts in the Zendesk Help Center. Use the Topic ID field to retrieve a single specific topic, or leave it empty to retrieve all topics. 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 topic is emitted as a separate 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 Topics

Topic ID

String/Expression

Enter the numeric Zendesk community topic ID to retrieve a single specific topic. Leave empty to retrieve all community topics in the Zendesk instance.

Default value: None

Example: 360001234567

Max results

Integer/Expression

Specify the maximum number of community topic 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