WhatsApp Flows

Send flow message

Send a published flow as an interactive message with a CTA button. When the recipient taps the button, the flow opens natively in WhatsApp. Flow responses are received via webhooks.

Billing: Request; paid actions are priced in credits (see GET /v1/messaging/prices) · Rate limit: 60/min

post/v1/messaging/whatsapp/flows/send

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/messaging/whatsapp/flows/send
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

tostring required

Recipient phone number (E.164 format, e.g. +1234567890)

bodystring required

Message body text

draftboolean

Set true to test an unpublished (DRAFT) flow

footerstring

Optional footer text

flow_idstring required

Published flow ID

flow_ctastring required

CTA button text (e.g. 'Book Now', 'Sign Up')

accountIdstring required

WhatsApp account ID

flow_tokenstring

Unique token to correlate responses. If omitted, auto-generated as '<flowId>:<uuid>' so the response can be attributed to this flow in the Flow Responses view.

flow_action'navigate' | 'data_exchange'

Action type: navigate opens a screen directly, data_exchange hits your endpoint first

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.