Handle hook

Triggers a webhook-based automation for a specific contact.

Use Case: Use this endpoint to trigger WhatsApp automations from external systems such as:

  • E-commerce platforms (order confirmations, shipping updates, abandoned cart reminders)
  • CRMs (lead follow-ups, appointment reminders)
  • Marketing automation tools (triggered campaigns based on user behavior)
  • Custom integrations with your own systems

Technical Details:

  • The webhook ID is generated when you create a "Webhook" trigger in your Wax automation
  • If the contact does not exist, it will be created automatically
  • Pass run-specific values in data — they become {{data.*}} variables in your automation flow (e.g. {{data.order_id}}) and are NOT written back to the contact
  • Use attributes only for values you want to permanently save on the contact, as it overwrites existing contact/CRM data
  • The automation must be active for the webhook to trigger; otherwise, a 422 error is returned
  • Requests without a phone_number are acknowledged with a 200 status and skipped, so senders do not record delivery failures for contacts missing a phone number
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique identifier of the webhook. This is generated when you create a webhook trigger in Wax.

Body Params
string
required

The contact phone number in E.164 format. The automation will be triggered for this contact.

string

The contact email address. Used to match existing contacts if phone number does not match.

attributes
object

⚠️ Persisted to the contact and overwrites existing values on your contact/CRM. Only use this when you intend to permanently update the contact. For data that should only be used inside this automation run, use data instead.

tags
array of strings

An array of tag names to assign to the contact before triggering the automation.

tags
data
object

Ephemeral event data for this automation run. Not saved to the contact. All keys are available as variables (e.g., {{data.order_id}}, {{data.customer.name}}) in your automation messages.

Headers
string
required

Bearer token

Responses
200

skipped - no phone number

204

successful

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json