The Digitaleo REST APIs use webhooks for event notification. Webhooks are HTTP callbacks that contains notification messages for events. After you configure a webhook listener for your app, you can create a webhook, which subscribes the webhook listener for your app to specific events. The notifications namespace contains resource collections for webhooks.
\nAfter you configure a webhook subscription, the events that you specified will trigger a webhook notification each time they occur. This notification contains a JSON payload, and HTTP headers that provide context. For example, the orders/create webhook includes the following headers:
\nX-Digitaleo-Event: contact.message.click\nX-Digitaleo-Timestamp: 1492774577\nX-Digitaleo-Signature: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=\nX-Digitaleo-Subscription: ad3f59688dddd4c4cc4cb75fbe65f5a2\nX-Digitaleo-Event-Id: bb3f59688dddd4c4cc4cb77fbe65f5a3\nSome HTTP headers are particularly useful for your app. For example, X-Digitaleo-Signature is used to verify webhooks
\nWebhook subscriptions are scoped only to the app that they're registered to. This means that when a webhook subscription is registered to an app, other apps can't view, modify, or delete it. For more information about how to authenticate webhooks, see Using webhooks. For general information about authentication, see the OAuth documentation.
\nWhen you subscribe to an event, you will always receive a collection of events with at least one event.
\nThe payload is a JSON array like so :
[\n { /* event */ },\n { /* event */ },\n { /* event */ }\n]\nYou will receive multiple notifications in a single request. The payload will contain maximum 50 notifications. We will send multiple notifications only when a lot of events have occurred within a short period of time. For example, if you've subscribed to new contacts and a customer imports a large number of contacts, we will send you the notifications for these imported contacts in batches and not one-per-request.
\nOtherwise, if within 10 minutes after processing an event, there are not enough events produced to fulfill completely a request, we will send a less filled one, e.g at given time T an contact updated event is produced, at given time + 10 minutes no other event has been generated, we will send you a request containing only information about previous contact updated event.
\nWe do not guarantee that you get these notifications in the order they occurred. Please use the eventTimestamp property for each notification to determine when the notification occurred.
\nWe do not guarantee that you will only get a single notification for an event. Though this should be rare, it is possible that we will send you the same notification multiple times.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Anatomy of a webhook","slug":"anatomy-of-a-webhook"},{"content":"Batching","slug":"batching"},{"content":"Order","slug":"order"},{"content":"Uniqueness","slug":"uniqueness"}],"owner":"6740351","collectionId":"81579922-e0b4-4e86-8961-7df68a020c68","publishedId":"S17oxppy","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-11-19T15:50:01.000Z"},"item":[{"name":"Authentication","item":[{"name":"Obtain access token","event":[{"listen":"test","script":{"id":"3687fb02-708b-4d14-b028-18a0250a5897","exec":["const data = JSON.parse(responseBody);\r","\r","pm.environment.set(\"token\", data.access_token);"],"type":"text/javascript"}}],"id":"7d897c59-2f05-443f-9cd0-eca0b5cf49bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"client_id\": \"{{clientId}}\",\n\t\"client_secret\": \"{{clientSecret}}\",\n\t\"grant_type\": \"client_credentials\"\n}"},"url":"https://oauth.messengeo.net/token","description":"This resource must be used to retrieve an access token in order to manage webhooks on this API. This is a oAuth2 request using client_credentials grant type.
It will respond with a 200 Ok if it succeed. Here's a response example :
{\n \"access_token\": \"...\",\n \"expires_in\": 3600,\n \"token_type\": \"bearer\",\n \"scope\": \"basic\"\n}\n\nstring required for webhook type
URL configured to listen on incoming POST notification messages containing event payload.
string required
Event's label you are subscribing to.
boolean optional
True or False depending on whether you want your subscription to be active right after the creation.
If omitted, the value is True
integer optional
Maximum notifications by payload (50 by default)
integer optional
Timeout in seconds for the webhook HTTP request (60 by default)
string optional
The secret to encrypt the payload. By default, it will generate a secret and return it.
See Validity of a webhook section
boolean optional
True if the subscription should be triggered for all affiliates (False by default), none impact if the user has no affiliate
array optional
List of the e-mail adress to contact when a webhook delivery webhook happend
string optional
webhook or polling, it depends the way you want to collect data \n
if omitted the value is webhook
Subscribes your webhook listener to events.
\nRead all subscriptions
\nA successful request returns the HTTP 200 OK status code.
\n","urlObject":{"protocol":"https","path":["webhooks","v1","subscriptions"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d631bee0-8db2-4eb0-8672-8c3635b95007"},{"name":"Unsubscribe a webhook","id":"a9c65ed9-e7cc-4954-9319-d2e67368ea68","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}","description":"A successful request returns the HTTP 204 No Content status code with no JSON response body.
\nList of properties of the subscription resource
\nType:
\nStatus:
\n","event":[{"listen":"prerequest","script":{"id":"e5c94e94-e0a6-49bf-af60-c02d22a34a27","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4f4b7abc-b687-4428-8928-a407752dcfda","type":"text/javascript","exec":[""]}}],"_postman_id":"6b87dab3-84e8-45c5-a931-3e29b4e40224"},{"name":"Updating your subscription","item":[{"name":"Enable a subscription","id":"9c0c58e7-649d-426d-b76e-ca5547f33159","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enabled\": true\n}"},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}","description":"Be sure to set the Content-Length header to zero
\n","urlObject":{"protocol":"https","path":["webhooks","v1","subscriptions","{{id}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"0e34f3ae-cab3-4287-a320-a438ba8cbe50","name":"Enable a webhook","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"enabled\": true}","options":{"raw":{"language":"json"}}},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9c0c58e7-649d-426d-b76e-ca5547f33159"},{"name":"Disable a subscription","id":"d3e8ccc1-d721-4849-9b81-2112196b5511","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"enabled\": false\n}"},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}","description":"Be sure to set the Content-Length header to zero
\n","urlObject":{"protocol":"https","path":["webhooks","v1","subscriptions","{{id}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"9e3dee15-4c64-4259-ab40-3b92df688a1e","name":"Disable a webhook","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\"enabled\": false}","options":{"raw":{"language":"json"}}},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}"},"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d3e8ccc1-d721-4849-9b81-2112196b5511"},{"name":"Update the url","id":"4d531ec1-1c4e-4763-9745-b465cc12a38e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"url\": \"https://www.my-new-url.com\"\n}"},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}","description":"We'll do our best to avoid losing notifications during the update but we cannot ensure it. To minize the risk, we recommend you to keep up for few minutes your old endpoint.
\n","urlObject":{"protocol":"https","path":["webhooks","v1","subscriptions","{{id}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"82a66be9-3fc9-44e2-9aed-0fad67026b2b","name":"Update the url","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"Bearer {{token}}"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\"url\":\"https://www.my-new-url.com\"}","options":{"raw":{"language":"json"}}},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"4d531ec1-1c4e-4763-9745-b465cc12a38e"},{"name":"Update alert emails","id":"20cdeb1e-f120-43b1-b9ff-9d19065feccc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"alertEmails\": [ // Take care, you should set all emails you want to use. Not only emails you want to add to the subscriptions.\n \"jhon.doe@email.com\",\n \"jane.doe@email.com\"\n ]\n}"},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}","description":"When updating subscription's alert emails, take care to set all emails you want to use. Not only new ones.
\nThe update will erase old emails with new one.
\n","urlObject":{"protocol":"https","path":["webhooks","v1","subscriptions","{{id}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"6e60e37f-7b82-474b-ba52-d291d2eab09a","name":"Update subscription's alert emails","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"alertEmails\": [\"jhon.doe@email.com\", \"jane.doe@email.com\"]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"20cdeb1e-f120-43b1-b9ff-9d19065feccc"}],"id":"83d3d932-3150-4fa9-8191-4f3eee60b5db","event":[{"listen":"prerequest","script":{"id":"e5c94e94-e0a6-49bf-af60-c02d22a34a27","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4f4b7abc-b687-4428-8928-a407752dcfda","type":"text/javascript","exec":[""]}}],"_postman_id":"83d3d932-3150-4fa9-8191-4f3eee60b5db","description":""},{"name":"Error, failure and timeout","item":[],"id":"c91c5be1-08ea-4042-ad9f-d64772710a51","description":"Digitaleo will consider the following cases to be failures:
\nNote that this means that bad requests (4XX) are not considered as failures, and will not be retried (naturally, neither are 2XX responses).
\nTimeouts may be configured on a per-Webhook-Configuration basis.
\nDelivery of a Webhook Notification will fail with a timeout error if:
\nIf your retry policy specifies a non-zero number of retries, Digitaleo will attempt to re-deliver Webhook Notifications whose delivery fails.
\nAfter a failure, Digitaleo will retry deliver of a Webhook after a cool-down duration. That duration is proportional to the number of failed attempts.
\n","event":[{"listen":"prerequest","script":{"id":"d212f07a-9076-4030-9d42-b04930abd518","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"324aadd0-749f-451b-a252-032caf2f9b84","type":"text/javascript","exec":[""]}}],"_postman_id":"c91c5be1-08ea-4042-ad9f-d64772710a51"},{"name":"Validity of a webhook","item":[],"id":"0485f1f4-77e4-4d84-89ff-759fbb737bbb","description":"Digitaleo signs the webhook events it sends to your endpoint, allowing you to validate that they were not sent by a third-party.
\nCreating a webhook endpoint on your server is no different from creating any page on your website. With PHP for example, you might create a new .php file on your server.
\nEach Digitaleo webhook includes X-Digitaleo-Signature header which contains the request's signature string and X-Digitaleo-Timestamp header which contains the request timestamp.
\nHere's an example POST request sent by Cloudinary:
\nPOST /my_notification_endpoint HTTP/1.1\nX-Digitaleo-Timestamp: 1368881627\nX-Digitaleo-Signature: cEUXAFwoe6iERtJ8BKPhCMivuK+6ChcF9xd+yPwtXhA=\nContent-Type: application/json\nThis is achieved by concatenating:
\nThe request body
\nThe timestamp (X-Digitaleo-Timestamp)
\n$signed_payload = $upload_response . $headers[\"X-Digitaleo-Timestamp\"];
\nCompute a HMAC with the SHA256 hash function, using the webhook secret as the key and the signed_payload string as the message.
\nbase64_encode(hash_hmac('sha256', $signed_payload, $secret, true));\nCompare the signature in the header (X-Digitaleo-Signature) to the expected signature. If a signatures match, it means that the request is validated :)
\nif (base64_encode(hash_hmac('sha256', $signed_payload, $secret, true)) === $headers['X-Digitaleo-Signature']) {\n //signatures match\n} \nelse {\n //signatures NOT match\n}\nA replay attack is when an attacker intercepts a valid payload and its signature and re-transmits them. To mitigate such attacks, Digitaleo includes a timestamp in the X-Digitaleo-Timestamp header. As this timestamp is part of the signed payload, it is also verified by the signature, so an attacker cannot change the timestamp without invalidating the signature. You can decide to reject the payload if the signature is valid but the timestamp is too old.
\nTo prevent against timing attacks, compare the request timestamp (X-Digitaleo-Timestamp) to current timestamp.
\nif ($headers[\"X-Digitaleo-Timestamp\"] <= strtotime('-2 hours')) {\n //Signatures match, but older than 2 hours\n} else {\n //Signatures match, and timestamp\n}\nFull PHP code example:
\n<?php\n\n //Read request body\n $body = file_get_contents('php://input');\n $api_secret = 'replace_with_real_api_secret';\n\n //Signature validation\n if (validateSignature(getallheaders(), $body, $api_secret)) {\n //Use the response for your needs\n $resposne = json_decode($body);\n\n } else {\n die(\"Validation failed\");\n }\n\n function validateSignature($headers, $upload_response, $api_secret)\n {\n $signed_payload = $upload_response . $headers[\"X-Digitaleo-Timestamp\"];\n\n /**\n * Compute a HMAC with the SHA256 hash function,\n * using the api secret as the key and the signed_payload\n * string as the message\n */\n if (base64_encode(hash_hmac('sha256', $signed_payload, $api_secret, true)) === $headers['X-Digitaleo-Signature']) {\n\n //To prevent against timing attacks, we compare the expected signature to each of the received signatures.\n if ($headers[\"X-Digitaleo-Timestamp\"] <= strtotime('-2 hours')) {\n //Signatures match, but older than 2 hours\n return false;\n } else {\n //Signatures match, and timestamp\n return true;\n }\n } else {\n //Signatures NOT match\n return false;\n }\n }\nTriggered when an email, a voicemail or a SMS is opened.
\n{\n \"contactId\": \"123456789\",\n \"contactRecipient\": \"michel.dupond@domain.com\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"campaignId\": \"138753\",\n \"campaignName\": \"Les soldes de janvier\",\n \"campaignType\": \"STANDARD\",\n \"messageId\": \"12345678\",\n \"media\": \"EMAIL\",\n \"eventTimestamp\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890\n}\n\nTriggered when a link is clicked in an email or a SMS.
\n{\n \"contactId\": \"123456789\",\n \"contactRecipient\": \"michel.dupond@domain.com\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"campaignId\": \"138753\",\n \"campaignName\": \"Les soldes de janvier\",\n \"campaignType\": \"STANDARD\",\n \"messageId\": \"12345678\",\n \"media\": \"EMAIL\",\n \"eventTimestamp\": 1549912706,\n \"linkUrl\": \"https://www.site.com/aproduct\",\n \"linkHtml\": \"<img class='preserveHtml' class='preserveHtml' class='preserveHtml' src=\\\"https://datas.messengeo.net/ad55b6afbe2007c1f5c557d566766caa/a7079415c42688fe8ad08079cda43fa2/monimage.jpg\\\" />\",\n \"linkTitle\": \"mon produit\",\n \"linkPart\": \"HTML\",\n \"linkPosition\": \"4\",\n \"contractId\": 1234,\n \"userId\": 567890\n}\n\nTriggered for any status update of a message (delivered, undelivered, ...)
\n{\n \"contactId\": \"123456789\",\n \"contactRecipient\": \"michel.dupond@domain.com\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"campaignId\": \"138753\",\n \"campaignName\": \"Les soldes de janvier\",\n \"campaignType\": \"STANDARD\",\n \"messageId\": \"12345678\",\n \"media\": \"EMAIL\",\n \"eventTimestamp\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890,\n \"codeShort\": \"ok\",\n \"codeDescription\": \"The message has been delivered\"\n}\n\nTriggered when a contact unsubscribe or is disabled.
\n{\n \"contactId\": \"123456789\",\n \"contactRecipient\": \"michel.dupond@domain.com\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"campaignId\": \"138753\",\n \"campaignName\": \"Les soldes de janvier\",\n \"campaignType\": \"STANDARD\",\n \"messageId\": \"12345678\",\n \"media\": \"EMAIL\",\n \"eventTimestamp\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890,\n \"reason\": \"contact\"\n}\n\nTriggered when a contact re-subscribe or is re-enabled.
\n{\n \"contactId\": \"123456789\",\n \"contactRecipient\": \"michel.dupond@domain.com\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"campaignId\": \"138753\",\n \"campaignName\": \"Les soldes de janvier\",\n \"campaignType\": \"STANDARD\",\n \"messageId\": \"12345678\",\n \"media\": \"EMAIL\",\n \"eventTimestamp\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890\n}\n\nTriggered when a contact is created.
\n{\n \"contactId\": \"123456789\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"eventTs\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890,\n \"data\": {\n \"id\": 497227081,\n \"email\": \"michel.dupond@domain.com\",\n \"phone\": \"+33296300090\",\n \"mobile\": \"+33689674523\",\n \"firstName\": \"Michel\",\n \"lastName\": \"DUPOND\",\n \"birthDate\": \"01/01/1970\",\n \"address1\": \"13 impasse des bleuets\",\n \"address2\": null,\n \"zipcode\": \"35310\",\n \"city\": \"BREAL SOUS MONTFORT\",\n \"country\": \"FRANCE\",\n \"company\": \"Google\",\n \"field01\": \"11/02/2019\",\n \"field15\": \"78-ETF-78\"\n }\n}\nTriggered when a contact is deleted.
\n{\n \"contactId\": \"123456789\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"eventTs\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890\n}\nTriggered when a contact is updated.
\n{\n \"contactId\": \"123456789\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"eventTs\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890,\n \"data\": {\n \"id\": 497227081,\n \"email\": \"michel.dupond@domain.com\",\n \"phone\": \"+33296300090\",\n \"mobile\": \"+33689674523\",\n \"firstName\": \"Michel\",\n \"lastName\": \"DUPOND\",\n \"birthDate\": \"01/01/1970\",\n \"address1\": \"13 impasse des bleuets\",\n \"address2\": null,\n \"zipcode\": \"35310\",\n \"city\": \"BREAL SOUS MONTFORT\",\n \"country\": \"FRANCE\",\n \"company\": \"Google\",\n \"field01\": \"11/02/2019\",\n \"field15\": \"78-ETF-78\"\n }\n}\nTriggered when a form is submitted.
\n{\n \"contactId\": \"123456789\",\n \"contactRecipient\": \"michel.dupond@domain.com\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"contactCategory\": \"DEFAULT\",\n \"campaignId\": \"138753\",\n \"campaignName\": \"Les soldes de janvier\",\n \"campaignType\": \"STANDARD\",\n \"media\": \"EMAIL\",\n \"eventTs\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890,\n \"data\":\n [\n {\n \"question\": \"Text of the question 1\",\n \"answer\": \"Text of the answer of the question 1\"\n },\n {\n \"question\": \"Text of the question 2\",\n \"answer\": \"Text of the answer of the question 2\"\n },\n {\n \"question\": \"Text of the question 3\",\n \"answer\": \"Text of the answer of the question 3\"\n }\n ]\n}\n\nTriggered when a reply of a SMS is received.
\n{\n \"contactId\": \"123456789\",\n \"contactRecipient\": \"+33601020304\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"campaignId\": \"138753\",\n \"campaignName\": \"Les soldes de janvier\",\n \"campaignType\": \"STANDARD\",\n \"messageId\": \"12345678\",\n \"eventTs\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890,\n \"response\": \"Text of the response\"\n}\n\nAll the following items are presented as one item to expose the anatomy of each event
\n⚠️ Keep in mind that payloads can be enhanced with new property at any time.
\n","event":[{"listen":"prerequest","script":{"id":"b4028a79-f5c6-4116-a7e1-bc285aafc9c3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"7c1204eb-344a-47b8-a68e-efa2cd880f49","type":"text/javascript","exec":[""]}}],"_postman_id":"fa057113-e446-46a7-b7df-c101b7dedd29"},{"name":"Metadata","item":[],"id":"c5e2b007-c56f-4ca3-a294-a88f76ed40c7","description":"You may have some metada links to your event. When added, an extra property will be append to your event payload.
\nThose metada are a great way to help you add more context to your campaings.
\nMetada can be of type :
\ndate and will be passed as string with Y-m-d formatstringFor example, given a contact.message.open event with 3 metadata :
START_DATE of type date END_DATE of type dateOFFER_CODE of type stringThe event payload could look like this :
\n{\n \"contactId\": \"123456789\",\n \"contactRecipient\": \"michel.dupond@domain.com\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"campaignId\": \"138753\",\n \"campaignName\": \"10% pendant les soldes de janvier\",\n \"campaignType\": \"STANDARD\",\n \"messageId\": \"12345678\",\n \"media\": \"EMAIL\",\n \"eventTimestamp\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890,\n \"metadata\": {\n \"START_DATE:\" \"2021-01-01\",\n \"END_DATE:\" \"2021-01-11\",\n \"OFFER_CODE\": \"JAN_SOLDES_10P\"\n }\n}\nThe event simulation allow the user to simulate a specific given subscription. Next, you will receive an event with this minimal informations :
\n\"Payload\": [\n {\n \"contractId\": /*your contract id*/,\n \"contractName\": \"contractName\",\n \"userId\": /*your user id*/,\n \"eventTimestamp\": /*the actual timestamp*/,\n \"contactId\": /*fake data*/,\n \"contactReference\": \"contactReference\",\n \"contactDeleted\": /*fake data*/,\n \"data\": {\n \"key\": \"value\"\n }\n }\n ],\n\nThe simulation will be sent to the specified subscription URL for webhook subscriptions, or will be retrievable via API call for polling subscriptions.
\nA successful request returns the HTTP 204 No Content status code with no JSON response body.
\nErrors can occur, for the simulation there are 3 different types of errors :
\n","urlObject":{"protocol":"https","path":["webhooks","v1","subscriptions","{{id}}","simulate"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"b9711977-938c-458a-a5bc-b58228740b94","name":"204 No Content","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}/simulate"},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"7cd0a9f7-c5b1-4764-8aa9-07a8e21c7f6c","name":"404 SUBSCRIPTION_NOT_FOUND","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}/simulate"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"SUBSCRIPTION_NOT_FOUND\",\n \"status_code\": 404\n }\n}"},{"id":"ba6f918b-f5b5-49f8-a03d-f2999bcf90d4","name":"422 MISSING_REQUIRED_FIELDS","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}/simulate"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"MISSING_REQUIRED_FIELDS\",\n \"status_code\": 422\n }\n}"},{"id":"e44b00a6-5011-4869-a46d-36e92c85c9e9","name":"422 DISPATCH_ERROR","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{token}}"}],"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}/simulate"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": {\n \"message\": \"DISPATCH_ERROR\",\n \"status_code\": 422\n }\n}"}],"_postman_id":"3bb1b375-10e4-428e-b177-8625fc130e34"}],"id":"aae24193-df74-4e35-9544-66b004236655","_postman_id":"aae24193-df74-4e35-9544-66b004236655","description":""},{"name":"Polling","item":[{"name":"Read Subscription's events","id":"9deb359c-1120-45de-b221-c6fe1001b1b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}/events","description":"This endpoint is only accessible if the provided id corresponds to a polling subscription.
Then, when you create a subscription via the API, be sure to use the correct parameter types. See “Subscribe a webhook”
\n","urlObject":{"protocol":"https","path":["webhooks","v1","subscriptions","{{id}}","events"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"a8867b39-1f48-491e-8b0a-b362e12afc9d","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}/events"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"contactId\": \"123456789\",\n \"contactRecipient\": \"michel.dupond@domain.com\",\n \"contactReference\": \"09fe888ab50bf17757b04ca7f22c76b5\",\n \"campaignId\": \"138753\",\n \"campaignName\": \"Les soldes de janvier\",\n \"campaignType\": \"STANDARD\",\n \"messageId\": \"12345678\",\n \"media\": \"EMAIL\",\n \"eventTimestamp\": 1549912706,\n \"contractId\": 1234,\n \"userId\": 567890\n }\n]"},{"id":"4c1367dc-df7d-439d-969b-4ea444dcf7f2","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"formdata","formdata":[]},"url":"https://api.digitaleo.com/webhooks/v1/subscriptions/{{id}}/events"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Subscription not found or not a polling subscription\"\n}"}],"_postman_id":"9deb359c-1120-45de-b221-c6fe1001b1b9"}],"id":"387680cc-83f2-4937-960a-9c4ff25be89f","description":"This mode allow you to retrieve your self the event rather than be notified on a public endpoint.
You'll retrieve the exact same data as with the webhook mode, the only difference is that you handle on your side the frequency you want aggregate data by calling our endpoint.
⚠️ Once an event is read, you can't retrieve it anymore. Take care to correctly save data on your side. On our side, read events are definetely deleted after 30 days.
\n","_postman_id":"387680cc-83f2-4937-960a-9c4ff25be89f"}],"event":[{"listen":"prerequest","script":{"id":"74b4a076-325e-40af-9470-6a0b4ce08f36","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"573e9232-e47e-4f1e-b2b5-69bfa5d2baf3","type":"text/javascript","exec":[""]}}]}