Read User Segments

Overview

The Read User Segments Snap retrieves user segment records from your Zendesk Help Center, with filtering options by segment ID, user, or applicability, and optional sideloading of associated sections and topics.

User segments in Zendesk define which users have access to specific Help Center content. Each segment record is emitted as a separate document on the output view. You can optionally include the Help Center sections and community topics that are restricted to each segment. 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 user segment is emitted as a separate document. When Include sections is selected, the Help Center sections restricted to each segment are included. When Include topics is selected, the community topics restricted to each segment are included. Both sideloads make additional API calls per segment.
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 User Segments
Filter mode

Dropdown list
Select the strategy for filtering the user segments to retrieve.
  • All Segments: Select to retrieve all user segments in the Help Center. Use the Built-in scope field to narrow results to built-in or custom segments only.
  • Applicable: Select to retrieve only the user segments that are applicable to the current context.
  • By ID: Select to retrieve a single user segment by its Zendesk segment ID. Requires the User segment ID field.
  • By User: Select to retrieve all user segments that a specific user belongs to. Requires the User ID field.

Default value: All Segments

Example: By User
Built-in scope

Dropdown list

Appears when Filter mode is All Segments, Applicable, or By User.

Select to filter the segments list by whether they are built-in (default) or custom (created by your account). Valid values:
  • Any: Select to return both built-in and custom segments.
  • Built-in only: Select to return only the default Zendesk segments.
  • Custom only: Select to return only the segments created by your Zendesk account.

Default value: Any

Example: Built-in only
User segment ID*

String/Expression

Appears when Filter mode is By ID.

Enter the numeric Zendesk user segment ID of the segment to retrieve.

Default value: None

Example: 360001234567
User ID*

String/Expression

Appears when Filter mode is By User.

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

Default value: None

Example: 123456789
Include sections

Checkbox

When selected, the Snap makes an additional API call per segment to retrieve the Help Center sections restricted to each segment, and includes them in the output document.

Default value: Not selected
Include topics

Checkbox

When selected, the Snap makes an additional API call per segment to retrieve the community topics restricted to each segment, and includes them in the output document.

Default value: Not selected
Max results

Integer/Expression

Specify the maximum number of user segment 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