Kapso APIInstall

Summary

Send a WhatsApp Flow message through a specified Kapso WhatsApp number to a recipient's phone number, optionally customizing message headers, body text, interactive button labels, initial data, and footer text to control the flow interaction.

Inputs

• Phone Number Name or ID — Select the connected Kapso WhatsApp number for sending the flow; options load dynamically from your Kapso project.
• Recipient Phone (required) — Enter the recipient's phone number in Meta format (8-15 digits, no plus sign or spaces).
• Flow Mode — Choose the lifecycle stage of the Flow to send: Auto (default using published flows), Draft (only draft flows), or Published (only published flows).
• Flow (required) — Select or specify the WhatsApp Flow to send, created and managed in Kapso Dashboard. If Flow Mode is Draft, only draft Flows are valid.
• Flow Header Type — Optional header type to display above the message body: None, Text, Image, Video, or Document.
• Flow Header Text (optional) — If header type is Text, provide header text up to 60 characters.
• Header Media Source — If header is an Image, Video, or Document, choose whether header media is specified by a public HTTPS URL or Kapso media ID.
• Header Media URL — Provide the public HTTPS URL if header media source is link.
• Header Media ID (optional) — Provide the Kapso media ID if header media source is ID.
• Header Document Filename (optional) — Filename shown for document header messages, up to 240 characters.
• Body Text (required) — Main message body text for the interactive flow message, up to 1024 characters.
• Flow Button Label (optional) — Button label text (1-20 characters) that opens the flow; defaults to the selected Flow's name if empty.
• Flow Token (optional) — Optional correlation token to track responses; if omitted, Kapso uses the Flow ID automatically.
• Flow Action (optional) — Specify the Flow action explicitly (e.g., Navigate or Data Exchange); leave empty to use the action detected from the Flow.
• Flow Screen (optional) — For Navigate action, select the first screen of the Flow to show; loaded dynamically from the flow builder.
• Flow Initial Data — Map initial data fields for the selected Flow screen as defined in the Kapso Flow builder.
• Flow Footer Text (optional) — Text shown below the interactive content as footer, up to 60 characters.
• Message Send Options — Additional optional settings for the outbound message such as replying to a specific message ID or attaching callback data for correlation.

Output shape

a single message send result object

The operation returns a single result object for the send flow message request. Optional parameters control interactive message layout and Flow interaction details such as initial data, action, and token. Errors may occur if Flow encryption is not configured when needed.

Links

• n8n community nodes installation guide