Webhooks

Jaroslav Bouška Jaroslav Bouška
4. října 2024

Společné properties

  • guid – GUID e-mailu
  • webhookType – typ webhooku
  • to – adresát emailu
  • from – odesílatel emailu
  • subject – předmět emailu
  • created – datum a čas vytvoření webhooku
  • sent – datum a čas odeslání emailu
  • sendingIp – IP adresa odesílacího profilu
  • sendingHostName – název odesílacího profilu
  • delivered – datum a čas doručení emailu

WebhookType

  • 1 – Doručení transakčního e-mailu
  • 2 – Proklik v odkazu transakčního e-mailu
  • 3 – Otevření transakčního e-mailu
  • 4 – Nedoručení transakčního e-mailu – soft bounce
  • 5 – Nedoručení transakčního e-mailu – hard bounce
  • 6 – Odhlášení z odběru transakčního e-mailu
  • 7 – Transakční e-mail byl označen jako SPAM
  • 10 – Doručení hromadného e-mailu
  • 11 – Proklik v odkazu hromadného e-mailu
  • 12 – Otevření hromadného e-mailu
  • 13 – Nedoručení hromadného e-mailu – soft bounce
  • 14 – Nedoručení hromadného e-mailu – hard bounce
  • 15 – Odhlášení z hromadného e-mailu
  • 16 – Hromadný e-mail byl označen jako SPAM

Webhooky k transakčním e-mailům

Společné properties pro transakční e-maily

  • transactionalEmailId – jednoznačný identifikátor tranksakčního emailu
  • groupId – group z transakčního emailu
  • tags – tagy z transakčního emailu

Doručení transakčního e-mailu

{
  "guid": "ad27ba14-a9c9-47dd-8ee8-d324cdf374ef",
  "webhookType": 1,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:26:31.4422353Z",
  "sent": "2024-10-02T10:26:31.4422473Z",
  "sendingIp": null,
  "sendingHostName": null,
  "transactionalEmailId": 0,
  "groupId": 0,
  "delivered": "2024-10-02T10:26:31.4930111Z",
  "tags": ""
}

Proklik v odkazu transakčního e-mailu

{
  "guid": "d2d9c596-8c44-4d66-a748-4e47b1920b4b",
  "webhookType": 2,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:27:22.1785811Z",
  "sent": "2024-10-02T10:27:22.1785821Z",
  "sendingIp": null,
  "sendingHostName": null,
  "transactionalEmailId": 0,
  "groupId": 0,
  "delivered": "2024-10-02T10:27:22.1785885Z",
  "tags": ""
}

Otevření transakčního e-mailu

{
  "guid": "f518b2ba-1f57-4f26-8dab-d8d3e17ac856",
  "webhookType": 3,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:28:03.8445444Z",
  "sent": "2024-10-02T10:28:03.8445538Z",
  "sendingIp": null,
  "sendingHostName": null,
  "transactionalEmailId": 0,
  "openId": 0,
  "groupId": 0,
  "delivered": "2024-10-02T10:28:03.850929Z",
  "userAgent": "Testing Chrome",
  "tags": ""
}
  • openId – jednoznačný identifikátor otevření
  • userAgent – identifikátor prohlížeče adresáta

Nedoručení transakčního e-mailu (nezávažný důvod)

{
  "guid": "2803b5c8-5537-4f8d-a450-c1a19d17cd72",
  "webhookType": 4,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:28:31.8344283Z",
  "sent": "2024-10-02T10:28:31.8344384Z",
  "sendingIp": null,
  "sendingHostName": null,
  "transactionalEmailId": 0,
  "groupId": 0,
  "deliveryInfoId": 0,
  "statusCode": "Any error code",
  "message": "Any bounce message",
  "tags": ""
}
  • deliveryInfoId – jednoznačný identifikátor informace o nedoručení
  • statusCode – Status code z mail serveru (např. 5.0.0)
  • message – Message z mail serveru (např. smtp; 550 5.1.1 Sorry, no mailbox here by that name.)

Nedoručení transakčního e-mailu ze závaženého důvodu

{
  "guid": "242eb8a0-c973-447b-8333-dc92185caa18",
  "webhookType": 5,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:29:16.5467345Z",
  "sent": "2024-10-02T10:29:16.5467345Z",
  "sendingIp": null,
  "sendingHostName": null,
  "transactionalEmailId": 0,
  "groupId": 0,
  "deliveryInfoId": 0,
  "statusCode": "Any error code",
  "message": "Any bounce message",
  "tags": ""
}
  • deliveryInfoId – jednoznačný identifikátor informace o nedoručení
  • statusCode – Status code z mail serveru (např. 5.0.0)
  • message – Message z mail serveru (např. smtp; 550 5.1.1 Sorry, no mailbox here by that name.)

Odhlášení z odběru transakčního e-mailu

{
  "guid": "0c28b9e9-443a-4852-8bae-e9fcd3be73a6",
  "webhookType": 6,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:29:44.7633792Z",
  "sent": "2024-10-02T10:29:44.7633795Z",
  "sendingIp": null,
  "sendingHostName": null,
  "transactionalEmailId": 0,
  "excludeListId": 0,
  "groupId": 0,
  "delivered": "2024-10-02T10:29:44.7634287Z",
  "tags": "",
  "userAgent": "Testing Chrome",
  "ipAddress": "0.0.0.0"
}
  • excludeListId – jednoznacny identifikator informace o odhlaseni
  • userAgent – identifikátor prohlížeče, ze kterého proběhlo odhlášení
  • ipAddress – IP adresa, ze které proběhlo odhlášení

E-mail byl označen jako SPAM

{
  "guid": "7a35eb56-afbf-4d39-bff1-954669021e35",
  "webhookType": 7,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:30:00.7747727Z",
  "sent": "2024-10-02T10:30:00.7747729Z",
  "sendingIp": null,
  "sendingHostName": null,
  "transactionalEmailId": 0,
  "excludeListId": 0,
  "groupId": 0,
  "delivered": "2024-10-02T10:30:00.7748154Z",
  "tags": ""
}
  • excludeListId – jednoznacny identifikator informace o odhlaseni

Webhooky k hromadným e-mailům

Společné properties pro hromadné e-maily

  • massEmailId – jednoznačný identifikátor hromadného emailu
  • campaignId – jednoznačný identifikátor kampaně
  • generatorExecutionId – jednoznačný identifikátor rozesílky

Doručení hromadného e-mailu

{
  "guid": "13406c56-2472-497e-a110-66b5e5d396ad",
  "webhookType": 10,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:30:32.4878476Z",
  "sent": "2024-10-02T10:30:32.4878479Z",
  "sendingIp": null,
  "sendingHostName": null,
  "massEmailId": 0,
  "campaignId": 0,
  "generatorExecutionId": 0,
  "delivered": "2024-10-02T10:30:32.4880243Z"
}

Proklik v hromadném e-mailu

{
  "guid": "74777f2e-6537-45dc-af80-444f19de6e58",
  "webhookType": 11,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:31:13.3817459Z",
  "sent": "2024-10-02T10:31:13.3817619Z",
  "sendingIp": null,
  "sendingHostName": null,
  "massEmailId": 0,
  "clickId": 0,
  "generatorExecutionId": 0,
  "delivered": "2024-10-02T10:31:13.384325Z",
  "linkUrl": "Url clicked link",
  "userAgent": "Testing Chrome",
  "ipAddress": "0.0.0.0"
}
  • clickId – jednoznačný identifikátor prokliku
  • linkUrl – URL prokliku
  • userAgent – identifikátor prohlížeče, ze kterého proběhl proklik
  • ipAddress – IP adresa, ze které proběhl proklik

Otevření v hromadném e-mailu

{
  "guid": "8c857ad4-1e47-4b45-b656-80bb38f827e7",
  "webhookType": 12,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-02T10:31:27.3091133Z",
  "sent": "2024-10-02T10:31:27.3091135Z",
  "sendingIp": null,
  "sendingHostName": null,
  "massEmailId": 0,
  "openId": 0,
  "generatorExecutionId": 0,
  "delivered": "2024-10-02T10:31:27.3092238Z",
  "userAgent": "Any bounce message"
}
  • userAgent – identifikátor prohlížeče, ze kterého proběhl proklik

Soft bounce při odeslání hromadného e-mailu

{
  "guid": "12811aeb-f3f7-4feb-9c85-d6f9c896702d",
  "webhookType": 13,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-03T06:17:36.0613193Z",
  "sent": "2024-10-03T06:17:36.0613288Z",
  "sendingIp": null,
  "sendingHostName": null,
  "massEmailId": 0,
  "campaignId": 0,
  "generatorExecutionId": 0,
  "deliveryInfoId": 0,
  "statusCode": null,
  "message": "Any bounce message"
}
  • deliveryInfoId – jednoznačný identifikátor informace o nedoručení
  • statusCode – Status code z mail serveru (např. 5.0.0)
  • message – Message z mail serveru (např. smtp; 550 5.1.1 Sorry, no mailbox here by that name.)

Hard Bounce při odeslání hromadného e-mailu

{
  "guid": "8a892dd7-8acf-4ba5-8d7d-bfcc59ba0083",
  "webhookType": 14,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-03T06:17:56.5698273Z",
  "sent": "2024-10-03T06:17:56.5698363Z",
  "sendingIp": null,
  "sendingHostName": null,
  "massEmailId": 0,
  "campaignId": 0,
  "generatorExecutionId": 0,
  "deliveryInfoId": 0,
  "statusCode": null,
  "message": "Any bounce message"
}
  • deliveryInfoId – jednoznačný identifikátor informace o nedoručení
  • statusCode – Status code z mail serveru (např. 5.0.0)
  • message – Message z mail serveru (např. smtp; 550 5.1.1 Sorry, no mailbox here by that name.)

Odhlášení z hromadného e-mailu

{
  "guid": "7b15f9bc-2882-4f02-b450-b5c042a4d336",
  "webhookType": 15,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-03T06:18:14.4457254Z",
  "sent": "2024-10-03T06:18:14.4457256Z",
  "sendingIp": null,
  "sendingHostName": null,
  "massEmailId": 0,
  "excludeListId": 0,
  "delivered": "2024-10-03T06:18:14.4457655Z",
  "generatorExecutionId": 0,
  "userAgent": "Testing Chrome",
  "ipAddress": "0.0.0.0"
}
  • excludeListId – jednoznacny identifikator informace o odhlaseni
  • userAgent – identifikátor prohlížeče, ze kterého proběhlo odhlášení
  • ipAddress – IP adresa, ze které proběhlo odhlášení

Hromadný e-mail byl označen jako SPAM

{
  "guid": "f43e5656-402e-4c9b-bf38-1e0865f85557",
  "webhookType": 16,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is test - TEST",
  "created": "2024-10-03T08:43:29.2766611Z",
  "sent": "2024-10-03T08:43:29.2766823Z",
  "sendingIp": null,
  "sendingHostName": null,
  "massEmailId": 0,
  "campaignId": 0,
  "generatorExecutionId": 0,
  "userAgent": "Testing Chrome",
  "ipAddress": "0.0.0.0",
  "delivered": "2024-10-03T08:43:29.2888803Z",
  "tags": null
}
  • userAgent – identifikátor prohlížeče, ze kterého proběhlo nahlášení
  • ipAddress – IP adresa, ze které proběhlo nahlášení