Download Attachment

Overview

The Download Attachment Snap downloads a Help Center article attachment from your Zendesk instance and emits it as a binary stream.

Provide the numeric attachment ID, which you can obtain from the output of the Read Help Center Articles Snap when Include attachments is selected. The attachment content is streamed to the output view as binary data. When Include metadata is selected, the attachment metadata (such as file name, content type, and size) is included as headers in the output document.



  • 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. This is useful for passing the attachment ID from an upstream Read Help Center Articles Snap.

Output

This Snap has one binary output view.

The attachment content is emitted as a binary stream. When Include metadata is selected, attachment metadata such as file name, content type, and size is included as headers in the output.

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: Download Attachment

Attachment ID*

String/Expression

Enter the numeric ID of the Help Center article attachment to download. You can obtain this value from the id field in the attachments array returned by the Read Help Center Articles Snap when Include attachments is selected.

Default value: None

Example: 360001234567

Include metadata

Checkbox

When selected, the metadata of the attachment (such as file name, content type, and file size) is included as part of the header of the output document alongside the binary content.

Default value: Selected

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