API Token
To begin with automation, you first need to generate an API token. This can be done on the automation page. You can also regenerate or remove your API token here.
Once a token is generated, this can be used to authenticate for our data endpoints via data connectors in Intercom or from your own backend.
Data Connectors
Our endpoints are intended to be used with data connectors to automate applying templates based on criteria you can define via workflows.
To use the API token in your data connectors, we recommend adding it as an authentication token in your Intercom workspace. (Settings -> Integrations -> Authentication -> Add Token)
For the request header, you will need to add "X-API-Key", and you don't need to add any prefix.
Once the token is added, it can be added as a HTTP header in your data connectors under the 'API connection' tab.
Endpoints
Load Template
Templates can be loaded for a given conversation via the conversation's ID and a template ID (template IDs can be seen on the templates page).
POST https://apps.intuitive.cx/tasks/data/load_template
POST https://apps.intuitive.cx/tasks/data/load_template
curl -X POST "https://apps.intuitive.cx/tasks/data/load_template" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY_HERE" \
-d '{
"conversation_id": 1,
"template_id": 1
}'
Using Data Connectors dynamically with workflows
In order to use your Data connector in a workflow, you need to adjust the Data connector to handle a parameter.
Under the "Api connection" tab, add a new "data input" that will represent your template ID.
You will then need to adjust your payload to use template_id instead of a hard coded value
Finally, when calling the data connector from your workflow, you will need to pass the proper value to the template_id variable.
You can now pass the template ID dynamically inside the workflow
