WAX API Reference | Flow & Contact

TRIGGER FLOW

- Description: Upon creating a flow with “Incoming webhook” trigger, a URL will be generated that you can use to trigger the flow programatically.

- Action: POST

- URL: (sample) https://app.getwax.io/hooks/bf658863-7b31-4b71-9137-fbd3a8add8ca

- Headers: Authorization: Bearer XYZ

- Payload:

(i) Trigger flow for a single customer

Parameters

(⚠️ required) phone_number (type: string or number, country code + digits)
(optional) email can be passed to improve contact matching if phone number is not present in wax
(optional) attributes can be passed with a hash to upsert customer attributes
(optional) All body parameters passed at the root of the payload will be stored as flow variables during the flow execution, and can be used as dynamic values.

Sample payload

{ "phone_number": 33600000000, "email": "contact@email.com", "attributes": { "enter_your_customer_attribute_key": "enter_your_customer_attribute_value" } }

UPSERT CONTACT

- Description: Used to create or update contact

- Action: POST

- URL: https://app.getwax.io/api/contacts

- Headers: Authorization: Bearer XYZ

- Payload:

(⚠️ required) phone_number (type: string or number, country code + digits)
(optional) attributes can be passed with a hash to upsert customer attributes
(optional) tags (type: array of strings) to set tags to the contact
(optional) language that will be used in case you want to use templates in multiple languages. See available languages below

Available Languages

Sample payload

{ "phone_number": 33600000000, "language": "fr", "tags": [ "enter_tag_1", "enter_tag_2" ], "attributes": { "first_name": "enter_first_name", "last_name": "enter_last_name", "email": "contact@email.com", "enter_any_customer_attribute_key": "enter_any_customer_attribute_value" } }