Hierbij een aantal voorbeelden van calls naar de webhook receiver. Hierbij hebben we rekening gehouden met een aantal verschillende niveaus en use cases. De simpelste is een aantal klantgegevens die plat worden doorgestuurd. Dit kan na het invullen van een contactformulier op de website zijn bijvoorbeeld.
\nEen call met orders voor een orderbevestiging of een sync met Deployteq is ook mogelijk, zodra je een array toevoegt. Hierbij zal Deployteq door de orders heen loopen en afhankelijk van de ontdubbeling voor elke order of orderregel, ook een regel aanmaken in het datamodel.
\nHet is uiteraard ook mogelijk om meerdere contacten in een array te zetten. Ook hier zal Deployteq voor elk contact in de array een nieuwe klant aanmaken of een klant updaten, afhankelijk van de ontdubbeling in Deployteq.
\nIn principe maakt het niet uit welke keys je doorstuurt in eerste instantie. Binnen Deployteq is er een interface die van de JSON een overzichtje maakt en per veld kan je aangeven in welke tabel en welk veld je het wilt opslaan in Deployteq. Pas als die eerste mapping is gemaakt, staat dit vast.
\nNa de eerste call krijg je de exacte data terug zoals je die gestuurd hebt richting Deployteq. Zodra er velden gemapt zijn en er worden daadwerkelijk records aangemaakt in Deployteq, zal je onderaan elk object daar het unieke Deployteq ID bij krijgen.
\nBelangrijk is wel de ontdubbelsleutel van de objecten. Binnen Deployteq maken veel klanten vaak gebruik van een e-mailadres of klantnummer om de klanten op te ontdubbelen. Dit veld is ook in de mapping te identificeren. Op basis van dit veld zal Deployteq het object opzoeken, en indien deze wordt gevonden zal deze worden geüpdatet en anders wordt deze nieuw aangemaakt.
\nBenieuwd hoe dit er in de interface in Deployteq uitziet? In onze documentatie vind je diverse screens en beschrijvingen
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"1. Welke velden stuur je door?","slug":"1-welke-velden-stuur-je-door"},{"content":"2. Responses","slug":"2-responses"},{"content":"3. Ontdubbeling","slug":"3-ontdubbeling"},{"content":"4. Extra documentatie","slug":"4-extra-documentatie"}],"owner":"6603240","collectionId":"64b8c9e6-72c5-412b-a7c6-19cd6ccebd84","publishedId":"Rztpp6zm","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FB8538"},"publishDate":"2020-02-27T09:31:48.000Z"},"item":[{"name":"call simpel","id":"6405d256-97cd-42fd-a318-dee0f94ccb82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"naam\": \"Angelo\",\n \"email\": \"a.vanderkleij@teamitg.com\",\n \"anders\": \"Verzin maar wat leuks\",\n \"blabla\": \"nog meer data\"\n}"},"url":"https://webhook.myclang.com/app/api/rest/public/v2/project/datahook/data-receiver/345-update-customer","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":true,"source":{"_postman_id":"64b8c9e6-72c5-412b-a7c6-19cd6ccebd84","id":"64b8c9e6-72c5-412b-a7c6-19cd6ccebd84","name":"API - Webhook","type":"collection"}},"urlObject":{"protocol":"https","path":["app","api","rest","public","v2","project","datahook","data-receiver","345-update-customer"],"host":["webhook","myclang","com"],"query":[],"variable":[]}},"response":[{"id":"4f66eaee-0496-416e-9c9c-a72360e84a18","name":"call simpel","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"naam\": \"Miranda\",\n \"email\": \"m.blom@e-village.nl\",\n \"anders\": \"Verzin maar wat leuks\",\n \"blabla\": \"nog meer data\"\n}"},"url":{"raw":"https://{{portal}}.myclang.com/app/api/rest/public/v2/project/datahook/data-receiver/345-update-customer?token={{token}}","protocol":"https","host":["{{portal}}","myclang","com"],"path":["app","api","rest","public","v2","project","datahook","data-receiver","345-update-customer"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 27 Feb 2020 09:33:49 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-Clang-Request-Count","value":"3","enabled":true},{"key":"X-Clang-Request-Limit","value":"50000","enabled":true},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"naam\": \"Miranda\",\n \"email\": \"m.blom@e-village.nl\",\n \"anders\": \"Verzin maar wat leuks\",\n \"blabla\": \"nog meer data\",\n \"__customer__id__\": 13\n}"}],"_postman_id":"6405d256-97cd-42fd-a318-dee0f94ccb82"},{"name":"call met orders","id":"308ea1f6-223b-4567-ba66-d338c87ef5bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"naam\": \"Miranda\",\n \"email\": \"tpm@teamitg.com\",\n \"anders\": \"Verzin maar wat leukks\",\n \"blabla\": \"nog meer data\",\n \"campagnenaam\": \"transactioneel\",\n \"order\": {\n \"order_id\": \"1\",\n \"total\": \"49.5\",\n \"shipping\": \"5\",\n \"products\": [\n {\n \"SKU\": \"123\",\n \"name\": \"Product1\",\n \"price\": \"21.5\"\n },\n {\n \"SKU\": \"123\",\n \"name\": \"Product2\",\n \"price\": \"28\"\n }\n ]\n }\n}"},"url":"https://webhook.myclang.com/app/api/rest/public/v2/project/datahook/data-receiver/346-orders","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":true,"source":{"_postman_id":"64b8c9e6-72c5-412b-a7c6-19cd6ccebd84","id":"64b8c9e6-72c5-412b-a7c6-19cd6ccebd84","name":"API - Webhook","type":"collection"}},"urlObject":{"protocol":"https","path":["app","api","rest","public","v2","project","datahook","data-receiver","346-orders"],"host":["webhook","myclang","com"],"query":[],"variable":[]}},"response":[{"id":"a282cc18-1e92-429e-b89b-a6b89198f405","name":"call met orders","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"naam\": \"Miranda\",\n \"email\": \"m.blom@e-village.nl\",\n \"anders\": \"Verzin maar wat leukks\",\n \"blabla\": \"nog meer data\",\n \"campagnenaam\": \"transactioneel\",\n \"order\": {\n \"order_id\": \"1\",\n \"total\": \"49.5\",\n \"shipping\": \"5\",\n \"products\": [\n {\n \"SKU\": \"123\",\n \"name\": \"Product1\",\n \"price\": \"21.5\"\n },\n {\n \"SKU\": \"123\",\n \"name\": \"Product2\",\n \"price\": \"28\"\n }\n ]\n }\n}"},"url":{"raw":"https://{{portal}}.myclang.com/app/api/rest/public/v2/project/datahook/data-receiver/346-orders?token={{token}}","protocol":"https","host":["{{portal}}","myclang","com"],"path":["app","api","rest","public","v2","project","datahook","data-receiver","346-orders"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 27 Feb 2020 09:39:44 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-Clang-Request-Count","value":"5","enabled":true},{"key":"X-Clang-Request-Limit","value":"50000","enabled":true},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"naam\": \"Miranda\",\n \"email\": \"m.blom@e-village.nl\",\n \"anders\": \"Verzin maar wat leukks\",\n \"blabla\": \"nog meer data\",\n \"campagnenaam\": \"transactioneel\",\n \"order\": {\n \"order_id\": \"1\",\n \"total\": \"49.5\",\n \"shipping\": \"5\",\n \"products\": [\n {\n \"SKU\": \"123\",\n \"name\": \"Product1\",\n \"price\": \"21.5\",\n \"__orderedItems__id__\": 1\n },\n {\n \"SKU\": \"123\",\n \"name\": \"Product2\",\n \"price\": \"28\",\n \"__orderedItems__id__\": 1\n }\n ],\n \"__orders__id__\": 1\n },\n \"__customer__id__\": 13,\n \"__orders__id__\": 1\n}"}],"_postman_id":"308ea1f6-223b-4567-ba66-d338c87ef5bd"},{"name":"call met uitgebreide orders","id":"fcde4b3c-7b64-4d62-b94e-5056cb3c50f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstname\": \"Miranda\",\n \"surname\": \"Blom\",\n \"gender\": \"WOMAN\",\n \"email\": \"tpm@teamitg.com\",\n \"gender\": \"Female\",\n \"campaign\": \"transaction\",\n \"order\": {\n \"order_id\": \"1234\",\n \"total\": \"49.5\",\n \"shipping\": \"5\",\n \"date\": \"2017-08-24\",\n \"status\": \"Delivered\",\n \"payment\": \"iDeal\",\n \"products\": [\n {\n \"articleID\": \"123\",\n \"name\": \"Product1\",\n \"price\": \"21.5\",\n \"category\": \"sneakers\",\n \"color\": \"white\",\n \"size\": \"38\"\n },\n {\n \"articleID\": \"456\",\n \"name\": \"Product2\",\n \"price\": \"88.25\",\n \"category\": \"pumps\",\n \"color\": \"purple\",\n \"size\": \"38\"\n }\n ]\n }\n}"},"url":"https://webhook.myclang.com/app/api/rest/public/v2/project/datahook/data-receiver/22-orders","urlObject":{"protocol":"https","path":["app","api","rest","public","v2","project","datahook","data-receiver","22-orders"],"host":["webhook","myclang","com"],"query":[],"variable":[]}},"response":[{"id":"8164fe26-fe62-4d2a-8f9b-a2f4d04a4092","name":"call met uitgebreide orders","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"firstname\": \"Miranda\",\n \"surname\": \"Blom\",\n \"gender\": \"WOMAN\",\n \"email\": \"m.blom@e-village.nl\",\n \"anders\": \"Verzin maar wat leuks\",\n \"blabla\": \"nog meer data\",\n \"campagnenaam\": \"transactioneel\",\n \"order\": {\n \"order_id\": \"1234\",\n \"total\": \"49.5\",\n \"shipping\": \"5\",\n \"date\": \"2017-08-24\",\n \"status\": \"Delivered\",\n \"payment\": \"iDeal\",\n \"products\": [\n {\n \"articleID\": \"123\",\n \"name\": \"Product1\",\n \"price\": \"21.5\",\n \"category\": \"sneakers\",\n \"color\": \"white\",\n \"size\": \"38\"\n },\n {\n \"articleID\": \"456\",\n \"name\": \"Product2\",\n \"price\": \"88.25\",\n \"category\": \"pumps\",\n \"color\": \"purple\",\n \"size\": \"38\"\n }\n ]\n }\n}"},"url":{"raw":"https://{{portal}}.myclang.com/app/api/rest/public/v2/project/datahook/data-receiver/346-orders?token={{token}}","protocol":"https","host":["{{portal}}","myclang","com"],"path":["app","api","rest","public","v2","project","datahook","data-receiver","346-orders"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 27 Feb 2020 09:40:48 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-Clang-Request-Count","value":"6","enabled":true},{"key":"X-Clang-Request-Limit","value":"50000","enabled":true},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"firstname\": \"Miranda\",\n \"surname\": \"Blom\",\n \"gender\": \"WOMAN\",\n \"email\": \"m.blom@e-village.nl\",\n \"anders\": \"Verzin maar wat leuks\",\n \"blabla\": \"nog meer data\",\n \"campagnenaam\": \"transactioneel\",\n \"order\": {\n \"order_id\": \"1234\",\n \"total\": \"49.5\",\n \"shipping\": \"5\",\n \"date\": \"2017-08-24\",\n \"status\": \"Delivered\",\n \"payment\": \"iDeal\",\n \"products\": [\n {\n \"articleID\": \"123\",\n \"name\": \"Product1\",\n \"price\": \"21.5\",\n \"category\": \"sneakers\",\n \"color\": \"white\",\n \"size\": \"38\",\n \"__orderedItems__id__\": 2\n },\n {\n \"articleID\": \"456\",\n \"name\": \"Product2\",\n \"price\": \"88.25\",\n \"category\": \"pumps\",\n \"color\": \"purple\",\n \"size\": \"38\",\n \"__orderedItems__id__\": 3\n }\n ],\n \"__orders__id__\": 2\n },\n \"__customer__id__\": 13,\n \"__orders__id__\": 2\n}"}],"_postman_id":"fcde4b3c-7b64-4d62-b94e-5056cb3c50f9"},{"name":"call meerdere contacts","id":"c25a30f4-2bfb-4bea-af79-30eee30667b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"naam\": \"Miranda\",\n \"email\": \"m.blom@e-village.nl\",\n \"anders\": \"Verzin maar wat leuks\",\n \"blabla\": \"nog meer data\"\n },\n {\n \"naam\": \"Angelo\",\n \"email\": \"a.vanderkleij@e-village.nl\",\n \"anders\": \"Comment van de klant\",\n \"blabla\": \"ook voor een customer option\"\n }\n ]\n}"},"url":"https://webhook.myclang.com/app/api/rest/public/v2/project/datahook/data-receiver/347-multiple-customers","description":"Met deze call kan je meerdere contacten doorsturen, ook kan je hier nog een niveau dieper gaan, wanneer je bij die contacten bijvoorbeeld orders wilt toevoegen.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]},"isInherited":true,"source":{"_postman_id":"64b8c9e6-72c5-412b-a7c6-19cd6ccebd84","id":"64b8c9e6-72c5-412b-a7c6-19cd6ccebd84","name":"API - Webhook","type":"collection"}},"urlObject":{"protocol":"https","path":["app","api","rest","public","v2","project","datahook","data-receiver","347-multiple-customers"],"host":["webhook","myclang","com"],"query":[],"variable":[]}},"response":[{"id":"eb4706fd-e6dd-4ea3-8bca-a2fded6c5e0c","name":"call meerdere contacts","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"contacts\": [\n {\n \"naam\": \"Miranda\",\n \"email\": \"m.blom@e-village.nl\",\n \"anders\": \"Verzin maar wat leuks\",\n \"blabla\": \"nog meer data\"\n },\n {\n \"naam\": \"Angelo\",\n \"email\": \"a.vanderkleij@e-village.nl\",\n \"anders\": \"Comment van de klant\",\n \"blabla\": \"ook voor een customer option\"\n }\n ]\n}"},"url":{"raw":"https://{{portal}}.myclang.com/app/api/rest/public/v2/project/datahook/data-receiver/347-multiple-customers?token={{token}}","protocol":"https","host":["{{portal}}","myclang","com"],"path":["app","api","rest","public","v2","project","datahook","data-receiver","347-multiple-customers"],"query":[{"key":"token","value":"{{token}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx","enabled":true},{"key":"Date","value":"Thu, 27 Feb 2020 09:55:27 GMT","enabled":true},{"key":"Content-Type","value":"application/json","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Vary","value":"Accept-Encoding","enabled":true},{"key":"X-Clang-Request-Count","value":"8","enabled":true},{"key":"X-Clang-Request-Limit","value":"50000","enabled":true},{"key":"Content-Security-Policy","value":"frame-ancestors 'self'","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"Strict-Transport-Security","value":"max-age=31536000; includeSubDomains","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"contacts\": [\n {\n \"naam\": \"Miranda\",\n \"email\": \"m.blom@e-village.nl\",\n \"anders\": \"Verzin maar wat leuks\",\n \"blabla\": \"nog meer data\",\n \"__customer__id__\": 13\n },\n {\n \"naam\": \"Angelo\",\n \"email\": \"a.vanderkleij@e-village.nl\",\n \"anders\": \"Comment van de klant\",\n \"blabla\": \"ook voor een customer option\",\n \"__customer__id__\": 19\n }\n ]\n}"}],"_postman_id":"c25a30f4-2bfb-4bea-af79-30eee30667b2"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearer_token}}"}]}},"event":[{"listen":"prerequest","script":{"id":"fce0f7aa-94f9-4774-89b2-acc538db07e9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"e319b34e-ae9c-4a75-a628-99d18f6b6b8a","type":"text/javascript","exec":[""]}}]}