Webhooks
What is a Webhook?
A Webhook is an event callback, used by remote applications to receive notifications of events from Carma. Events will be sent to the URL provided. From one of the following IPs depending on the server of your Carma account:
ONE – 81.201.223.18
TWO – 81.201.223.150
THREE – 81.201.223.153
FIVE – 184.107.113.20
You can create Webhooks for:
Bounce – email address hard bounces
Enduser updated – enduser property updated via link click function
Link clicked – any link is clicked
Mail opened – mail opened
Opt out – click on unsubscribe link
SMS Inbox – incoming mobile number registration
Trigger Failed – any trigger request error
Optin – Recipient created via Carma Optin form.
Setup
Webhooks is a feature that we at Compost need to activate for you if you would like to use the feature. Please get in contact with your Account manager or email support@compost.se for more info.
The feature is not visible for Carma users yet, it is only we at Compost who can set this up for you. Here is how it looks in Carma:
Examples
The data that will be sent via Webhook from Carma is as follows from some examples.
Mail opened
{"listId":6862,"eventId":421213691,"contactId":"78605652","campaignId":310216,"sentTimestamp":"2015-06-29T11:07:49.913+02:00","carmaContactId":78605652,"campaign":"web hook test #1","project":"Newsletter","description":"MailOpened","list":"lars","projectId":4,"timestamp":"2015-06-29T11:07:49.913+02:00"}
Link clicked
{"eventId":421213692,"contactId":"78605652","campaignId":310216,"linkTarget":"http://www.dn.se?new_parameter=example_placeholder¶meter_name=parameter_value&mallgroda=2&skorpgrus=yes&slang=hallon",
"project":"Newsletter","clickTimestamp":"2015-06-29T11:11:07.297+02:00","description":"ClickedLink","list":"lars","listId":6862,"carmaContactId":78605652,"campaign":"web hook test #1","projectId":4,"timestamp":"2015-06-29T11:11:07.297+02:00"}
Opt out (unsubscribed)
{"eventId":421213698,"contactId":"78605652","campaignId":310217,"project":"Newsletter","description":"OptOut",
"list":"lars","listId":6862,"carmaContactId":78605652,"campaign":"web hook test #2","comment":null,"projectId":4,"unsubscribeTimestamp":"2015-06-29T11:29:35.797+02:00","timestamp":"2015-06-29T11:29:35.797+02:00"}
Bounce
{"eventId":1544584357,"bounceStatusCode":"5.7.1 (delivery not authorized)","contactId":"test-SE-4e1010e14382c980@test.xxxx.xxxx","bounceType":1,"campaignId":xxxxxxxx,"bounceTimestamp":"2017-01-11","project":"Account","bounceDomain":"test.xx.xxx","description":"Bounce","bounceMessage":"relaying-issues","list":"Email verification","bounceRecipient":"test-SE-4e1010e14382c980@test.xxxx.xxxxx","listId":19350,"carmaContactId":xxxxxxxxx,"campaign":"Email verification xxxxxx + xxxxxxx templatefix","projectId":7656,"timestamp":"2017-01-11T09:00:28.063+01:00"}
Trigger failed
{"eventId":421213701,"reason":"FAILED_TO_RENDER","contactId":"lars@compost.se","campaignId":310219,"triggerId":941,
"project":"Ny mall","description":"TriggerSendFailed","trigger":"webhook fail test","list":"datetest","listId":21877,"carmaContactId":385669043,"campaign":"failed trigger test","projectId":1256,"timestamp":"2015-06-29T14:14:32.723+02:00"}
Enduser updated
{“listId”:23481,“eventId”:503916682,“contactId”:“fredrik@compostmarketing.com”,“property”:“city”,“carmaContactId”:421497130,“listName”:” brand new”,“value”:“london”}
Optin
{"listId":23610,"eventId":503965015,"contactId":"fredrik@compost.se","carmaContactId":421506676,"description":"OptIn","list":"optin lyster","timestamp":"2017-11-22T16:04:04.063+01:00"}
SMS Inbox
{
“timestamp”: “2018-04-03T13:20:15.413+02:00″, “message”: “stop”, “sender”: “46733152311″, “shortCode”: 72456, “eventId”: 1986037821, “listId”: 42261, “description”: “SmsInbox”, “keyword”: “compost2 igen”, “originalId”: “5aa504b0-9811-4dc4-3f85-01a4423a8d7b”, “sentTimestamp”: “2018-04-03T13:20:15.413+02:00”, “country”: “se”}