This article assumes that you are familiar with how Octopods API & Intercom Series works. If you are not, I highly recommend reading our API reference for WhatsApp or SMS.
After Creating The Series
Octopods integration comes after you finish creating your Intercom Series based on your needs. For more information on using Intercom Series, check out this article.
1. Adding the Webhook block
You can add the Webhook Block anywhere in your Series, but make sure to be triggered only once. Recommended to add the Webhook Block to the end of your Series.
2. Grab your Octopods details
Before integrating the Series with Octopods API, there is some information that would be handy to grab first. Use the above links to our API for guidance.
Your Octopods Channel API Key
Your Octopods Template ID (in case of sending WhatsApp Template)
Your Octopods URL
Create the Webhook Block
Press on the webhook block after connecting it to your Series flow to open the settings tab.
1. Set HTTP Method: POST
2. Fill in the Webhook URL
Use the corresponding URL for either Whatsapp or SMS. In this example, we are sending a WhatsApp template. Make sure to replace the template ID in the URL.
3. Fill in the Webhook Header
Populate the Key field with X-Octopods-Auth and the value field with your API key
You can find your API key from your Octopods channel dashboard. See here.
4. Fill in the Webhook body
destination_phone: the recipient's phone number (required)
FOR SMS:
body: the SMS content (required)
Use Intercom Contact Attributes in the Webhook body for SMS
You can use intercom attributes to populate the above Webhook body fields, just append the Intercom attribute to your SMS body.
Done for SMS!
FOR WHATSAPP:
If you're sending a WhatsApp template without body variables, you're done!
message_variables: an array of strings of the message variables in the template body - make sure to include variables between quotation marks (required only if your template has message variables)
Note: if your template has variables in the header, you will have to use the hash format for the message variables:
{ "body": ["variable1", "variable2"], "header": ["variable1"] }
Use Intercom Contact Attributes in the Webhook body for Whatsapp
You can use intercom attributes to populate the above Webhook body fields, but make sure to include the variables between quotation marks to avoid errors.
Done for WhatsApp!