This article is for technical users / developers to sync contact details from Envoke to an external database (CRM).
Web hooks allow you to receive all contact data when contact details change in Envoke. You can then update your CRM system with the new data.
All data is provided in the contact data object. This includes all basic fields, custom field, tags, subscriptions and consent details.
Web hooks send data to a specific URL, similar to how push notifications work, via a POST request. Your IT team needs to add code to this URL to "listen" for changes and use the updated contact fields to update your CRM system.
Supported Event Types
Category | Type |
Contact |
|
Submission |
|
Email Activity |
|
email_delivery is reserved for an upcoming release: you can subscribe to it now, but no events are delivered yet.
Use these values for the "type" field when setting up a hook.
NOTE: all of the "submission" types send a contact data object with additional fields related to the submission. For an example see: form submission web hook.
Return list of hooks
curl -X GET -u {API_USER_ID}:{API_PASSWORD} "https://e1.envoke.com/v1/hooks"
Return a hook
Provide ID.
curl -X GET -u {API_USER_ID}:{API_PASSWORD} "https://e1.envoke.com/v1/hooks/{ID}"
Create a hook
Example data with Zapier endpoint, "consent_change" type.
curl -X POST -u {API_USER_ID}:{API_PASSWORD} -d "{\"url\":\"https://hooks.zapier.com/hooks/standard/1234/c739af1508294c6fa791f8a287cf8b8b/\",\"type\":\"consent_change\"}" "https://e1.envoke.com/v1/hooks"
Remove a hook
Provide ID.
curl -X DELETE -u {API_USER_ID}:{API_PASSWORD} "https://e1.envoke.com/v1/hooks/{ID}"