Calling Bik Initiatie flow API can be useful if you want to connect BIK with another third party system. It takes hardly 10 minutes to integrate and allows you to create custom workflows.
Use cases
Trigger messages to users via whatsapp, email and sms when any event happens on the Nector Loyalty Platform
Initiate a flow for NDR and other shipping use cases where a response message is expected (clickpost)
Steps
1. Make a new empty journey
Make a new empty journey and copy the journey id from the url
In the above 21storderdeliveredonlyzoho6880 is the journey id.
2. Generate your app secret by going to developer tools
We would need key, secret and appId, you can generate them by going here
3. Make a list of variables you need for the journey
Send a curl request to let the system know which variables will be available for the use in the journey builder.
Example if you want to use customerName and orderName send a sample curl request like below
In the below curl request make sure to change
Auth Token
appId
flowId
carryPayload with the variables which you want to use
curl --location 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-initiateFlow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic YzAxYjdiZDYxYTY6YzQzNGE4NmQzZDY1ZjdmYjMxMGIx' \
--data '{
"appId": "mSmvUqdfWO2HV3W4jyGZ",
"medium": "whatsapp",
"flowId": "21storderdeliveredonlyzoho6880",
"phoneNumber": "+919642538425",
"carryPayload": {
"customerName": "ashutosh",
"orderName": "1234"
}
}'
Using these variables in journey
Once you call the above rest end point, the above variables will be available for use in the journey builder as payload variables.
For more details you can also refer to this document