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.
Works in 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 |
|
| 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
| Field/Field set | Description |
|---|---|
Label* String |
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
Default value: None Example: |
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
Default value: 5 Example: |
Retry interval (seconds)
Integer/Expression |
Enter the number of seconds to wait between retry attempts. Default value: 3 Example: |
|
Snap execution Dropdown list
|
Choose one of the three modes in
which the Snap executes. Available options are:
Default value: Validate & execute |
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
| Unable to connect to Zendesk: <details> | The Snap could not connect to your Zendesk instance with the selected account, because of an authentication or network problem. | Verify the subdomain and credentials in the account, and that the Snaplex can reach your Zendesk instance. Then run the pipeline again. |
| Authentication failed. | Zendesk rejected the account credentials with HTTP 401 (Unauthorized). | Verify the credentials in the account, then run the pipeline again. |
| Invalid request. | Zendesk rejected the request with HTTP 400 (Bad Request) or HTTP 422
(Unprocessable Entity). The reason field in the error document
shows which. |
Review the Snap settings and the values in the input document, correct any value that Zendesk does not accept, and run the pipeline again. |
| Access denied. | Zendesk returned HTTP 403 (Forbidden). The Zendesk user behind the account does not have permission for the requested resource. | Use an account whose Zendesk user has at least the Agent role, or the permissions the operation requires. |
| Resource not found. | Zendesk returned HTTP 404 (Not Found). The ID in the Snap settings or input document does not exist in your Zendesk instance, or the record was deleted. | Verify the ID, and make sure the record still exists in Zendesk. |
| Rate limit exceeded. | Zendesk returned HTTP 429 (Too Many Requests), and the rate limit was still exceeded after the Snap's automatic retries. | Reduce the volume of requests, for example by retrieving fewer records per run, or schedule the pipeline outside peak hours. |
| Zendesk server error. | Zendesk returned HTTP 500, 502, 503, or 504, and the error persisted after the configured retries. | Wait a few minutes and run the pipeline again. If the error recurs, increase Retry attempts or Retry interval (seconds). |
| Network error while calling Zendesk. | The Snap could not reach Zendesk, for example because of a connection timeout or a DNS failure. | Verify that the Snaplex can reach your Zendesk instance, then run the pipeline again. |
| The <field> provided is not valid | An ID field, such as User ID or Ticket ID, received a value that is not a whole number. Zendesk ID fields accept integer values only. | Enter the numeric Zendesk ID, or fix the expression so that it evaluates to one. |
| Attachment ID is required. | Attachment ID is empty, or evaluates to 0. | Enter the ID of the attachment to download. |
| Failed to download attachment <attachment ID>. | An error occurred while the Snap downloaded the attachment from Zendesk. | Verify the attachment ID, and that the account has read access to the article the attachment belongs to. |