This article is for technical users / developers to sync communications details from Envoke to an external database (CRM).
The email activity webhooks currently supported are:
email_autoresponder_send
Future planned webhooks include:
email_send
email_open
email_click
Example using email_autoresponder_send
Whenever Envoke sends an automated message, have the related data send to an endpoint for your integration. Envoke uses web hooks to send data to you.
Set up the hook
An example cURL request to create a new "email_autoresponder_send" hook:
curl -X POST -u {API_USER_ID}:{API_PASSWORD} -d "{\"url\":\"https://path-to-my-integration.com\",\"type\":\"email_autoresponder_send\"}" "https://e1.envoke.com/v1/hooks"
Result
Once the hook has been setup, Envoke will make a POST request to the provided endpoint whenever the activity occurs.
Here's an example payload of what will be delivered:
[{
"activity_type": "email_autoresponder_send",
"timestamp": 1755271741,
"message_id": "398765",
"message_external_id": "28e811adb10bb224c0c629f46f30d515",
"message_name": "Welcome email",
"message_subject": "Welcome to our list!",
"contact_id": "343678",
"contact_email": "api-example@test.com",
"autoresponder_id": "1234",
"autoresponder_name": "Welcome series on form submission"
}]