OmnichannelInstall

Summary

Send a message (text, image, document, audio, or WhatsApp template) to a conversation.

Inputs

• Conversation ID (required) — UUID of the conversation to which the message will be sent.
• Content Type (required) — Select the message type: Text, Image, Document, Audio, or Template.
• Text Content — The text to send when Content Type is Text (max 4096 characters).
• Media URL — Public URL of the media file when Content Type is Image, Document, or Audio.
• Caption — Optional caption for media (max 1024 characters).
• MIME Type — Optional MIME type of the media file (e.g., image/jpeg, application/pdf, audio/mp3).
• Filename — Optional filename for a Document (only shown when Content Type is Document).
• Template Name — Name of the WhatsApp template to use when Content Type is Template.
• Template Language — Language code for the template (e.g., en_US) when Content Type is Template.
• Template Variables — Optional JSON object with variable substitutions for the template (header, body, button).

Output shape

Returns the sent message object from the Omnichannel API (typically includes message ID, status, timestamps, and any metadata).

If the request fails, the node throws an error that can be caught by an error-triggered workflow.

Examples

Example 1: Send a simple text reply

Set Conversation ID from previous node, Content Type = Text, and provide the reply in Text Content.

Example 2: Share a PDF invoice

Set Conversation ID, Content Type = Document, Media URL to the PDF, optionally set MIME Type to application/pdf and Filename to invoice.pdf.

Example 3: Send a WhatsApp order confirmation template

Set Conversation ID, Content Type = Template, Template Name = order_confirmation, Template Language = en_US, and Template Variables = { body: { 1: 'John', 2: 'Your order #' } }.