flow-webhook.mdx

title	Webhook for flows
api	POST /webhooks/flows/{id}
description	Learn how to trigger flows through webhooks
authMethod	none

Overview

Webhook Flow enables automatic WhatsApp message flows by sending HTTP POST requests. When a valid request is received, the system processes the data and initiates flow execution, sending template messages through WhatsApp and performing various other actions.

Path Parameters

The ID of the flow you want to trigger.You cab find the flow id by clicking on the trigger, if the flow you created is a webhook type.

Body Parameters

The first name of the recipient The recipient's phone number The two-letter country code. Must match the template message language. Optional URL for custom redirects. For abandoned cart automations, this should be the cart recovery URL. Optional discount code that you can send to the user. This will allow you to send unique discount code for each user directly into the WhatsApp template.

Response

HTTP status code indicating the result of the request A message describing the result of the request ```json 200 { "status": 200, "success": true } ```

{
  "status": 400,
  "error": "Invalid message format"
}

Important Notes

1. Rate Limiting: The same phone number cannot receive identical template messages within a 3-hour window.

2. Abandoned Cart Automation: When building abandoned cart flows:

   • The custom_url in the payload must be the cart recovery URL

   • In the "Send template message" action of type "Abandoned checkout", only call-to-action text can be customized (not the link)

3. Language Requirements: The template language must match the country code in the payload:

   • Example: If the template is in Italian (IT), the country_code must be "IT"

   • Mismatched languages will prevent template message delivery