Webhook as Triggers
A webhook as a trigger enables the initiation of BIK journeys from third-party external applications. These triggers are automated messages sent from one system to another when a specific event occurs. They facilitate real-time communication between applications by pushing data to a URL endpoint, which then triggers a predefined action in the receiving system.
Configuration of Webhook as Triggers:
Follow these three steps to configure webhook as triggers for WhatsApp channel:
1. Get the Webhook URL:
Get the webhook URL - The URL is auto generated and have details of flow id. This URL can now be added in third party applications to trigger the journey
Send sample data to the BIK webhook URL - Please refer to the dev documentation of third party application to get sample data. This step also ensures that the variables are now visible in the variable picker in the journey
2. Map Unique IDs:
Map the unique id that is common between both the platforms - it typically can be order id / name, shopify customer ID, phone number, email ID and external ID.
Extract a part of or all variables that third party application is sending on BIK platforms. We recommend extracting only relevant variables so that variable picker in journey is clean and manageable.
3. Optional Mapping:
Map responses from third party application to BIK variables. Typical use case would be to populate order or product variable set so that BIK variable names are usable. <Variable set for product would include: product name, price, URL, image, collection id and so on>
In addition to this feature, journeys can be triggered from third party applications using ‘trigger a flow api’ as well. Read here more for details
FAQs
1) What types of unique IDs should be mapped between platforms?
Unique IDs can include order ID, name, Shopify customer ID, phone number, email ID and external ID.
2) What is the optional step in configuring webhook triggers?
The optional step involves mapping responses from the third-party application to BIK variables, such as populating order, product, customer, and Shopify variable sets.
3) What does it mean to map payload variables to existing variables?
Mapping payload variables to existing variables means linking incoming data from an external payload to predefined variables in your system. This ensures that relevant data is stored and utilized appropriately.
For further assistance or to raise feature requests related to Webhook as triggers, please contact [email protected].