Skip to main content
Version: Current

Download WhatsApp Media

Description​

Downloads media content from the WhatsApp Business Platform using a WhatsApp Media ID.

The activity retrieves the media file and returns the content as base64-encoded data along with metadata such as MIME type, file size, and file name.

The Media ID is typically obtained from the WhatsApp Trigger activity or from previous workflow activity outputs.


Common Capabilities​

Process Data Support​

info

This activity supports dynamic configuration using values from the Process Data drawer.

You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and activity outputs.

Learn more → Using Process Data


Design-Time Configuration​

Connection Name​

Specifies the WhatsApp connection used for authentication and API communication.

Media ID​

Specifies the unique WhatsApp media identifier associated with the media file.

This value is typically obtained from:

  • WhatsApp Trigger activity outputs
  • Previous workflow activity outputs
  • Stored process data

File Name​

Specifies the optional filename assigned to the downloaded media.

If not provided, the Media ID may be used as the filename.


Wait All Incoming​

Execution Control

Controls how the activity behaves when multiple incoming execution paths converge.

Determines whether the activity executes when:

  • any incoming execution path completes, or
  • all relevant execution paths complete before execution

Learn more → Execution Control


On Error​

Error Handling Strategy

Defines how the workflow behaves if this activity encounters a runtime error.

Supported strategies include:

  • Fault
  • Continue
  • Suspend
  • Retry

Learn more → Error Handling


Outputs​

Raw JSON Response​

Contains the complete JSON response returned by the WhatsApp API during media retrieval.

Media ID​

Represents the unique identifier of the downloaded media.

MIME Type​

Represents the MIME type of the downloaded media file.

Examples include:

  • image/jpeg
  • video/mp4
  • application/pdf

File Size​

Represents the size of the downloaded media file in bytes.

File Name​

Represents the filename associated with the downloaded media.

Media Data (Base64)​

Contains the downloaded media content encoded as a base64 string.

The encoded content can be used for further processing, file storage, or integration with external systems.


Notes​

note
  • Media availability and retention are controlled by WhatsApp Business Platform policies.
  • Download access may fail if the media content has expired or is no longer available on the WhatsApp platform.
  • Large media downloads may impact workflow execution time and memory usage.