Read Groups

Overview

The Read Groups Snap retrieves group records from your Zendesk instance, with filtering options by group ID, user, or assignable scope.

Each group record is emitted as a separate document on the output view. Groups in Zendesk are collections of agents. Use the Assignable filter mode to retrieve only groups that can be assigned to tickets. Use the Max results field to limit the number of documents emitted. If the Snap encounters an error during execution, it rethrows the exception to the pipeline rather than writing it to the error view.



  • 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 Zendesk group record is emitted as a separate document.
Learn more about Error handling.

Snap settings

Important: If this Snap encounters an error during execution, the exception is raised at the pipeline level rather than being routed to the error view. Ensure that error handling is configured at the pipeline level when using this Snap.
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 Groups
Filter mode

Dropdown list
Select the strategy for filtering the groups to retrieve.
  • All Groups: Select to retrieve all groups in the Zendesk instance.
  • Assignable: Select to retrieve only the groups that can be assigned to tickets.
  • By ID: Select to retrieve a single group by its Zendesk group ID. Requires the Group ID field.
  • By User: Select to retrieve all groups that a specific user belongs to. Requires the User ID field.

Default value: All Groups

Example: By User
Group ID*

String/Expression

Appears when Filter mode is By ID.

Enter the numeric Zendesk group ID of the group to retrieve.

Default value: None

Example: 987654321
User ID*

String/Expression

Appears when Filter mode is By User.

Enter the numeric Zendesk user ID to retrieve all groups that this user belongs to.

Default value: None

Example: 123456789
Max results

Integer/Expression

Specify the maximum number of group records to emit per execution. Enter 0 or leave empty to emit all matching results.

Default value: None

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