Webhooks

Common properties

• guid – email GUID
• webhookType – webhook type.
• to – email recipient
• from – email sender
• subject – email subject
• created – date and time the webhook was created
• sent – date and time of email dispatch.
• sendingIp – IP address of the sending profile.
• sendingHostName – name of the sending profile
• delivered – date and time of email delivery.

Webhook Type

• 1 – Transactional email delivery
• 2 – Click-through on a transactional email link
• 3 – Transactional email open rate
• 4 – Transactional email not delivered – soft bounce
• 5 – Transactional email not delivered – hard bounce
• 6 – Unsubscribe from transactional emails
• 7 – Transactional email was marked as SPAM
• 10 – Bulk Email Delivery
• 11 – Click-through on a bulk email link
• 12 – Bulk Email Open Rate
• 13 – Bulk email not delivered – soft bounce
• 14 – Bulk email not delivered – hard bounce
• 15 – Unsubscribed from bulk email
• 16 – Bulk email was marked as SPAM.

Webhooks for transactional emails

Common properties for transactional emails

• transactionalEmailId – unique identifier for the transactional email
• groupId – group from the transactional email
• tags – tags from the transactional email.

Transactional email delivery

{
  "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": ""
}

Click-through on transactional email link

{
  "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": ""
}

Transactional email open rate

{
  "guid": "f518b2ba-1f57-4f26-8dab-d8d3e17ac856",
  "webhookType": 3,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is a 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 – unique identifier of the open rate
• userAgent – recipient’s browser identifier

Transactional email not delivered (minor reason)

{
  "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 – unique identifier of the delivery failure information.
• statusCode – Status code from the mail server (e.g. 5.0.0).
• message – Message from the mail server (e.g., SMTP; 550 5.1.1 Sorry, no mailbox here by that name.)

Transactional email not delivered due to a major reason.

{
  "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 – unique identifier of the delivery failure information.
• statusCode – Status code from the mail server (e.g. 5.0.0).
• message – Message from the mail server (e.g., SMTP; 550 5.1.1 Sorry, no mailbox here by that name.)

Unsubscribe from transactional emails

{
  "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 – unique identifier for unsubscribe information.
• userAgent – identifier of the browser from which the logout occurred.
• ipAddress – IP address from which the logout occurred

Email was marked as 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 – unique identifier for unsubscribe information.

Webhooks for bulk emails

Common properties for bulk emails

• massEmailId – unique identifier of the bulk email.
• campaignId – unique campaign identifier
• generatorExecutionId – unique identifier for deliveries.

Bulk email delivery

{
  "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"
}

Click-through in bulk email

{
  "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": "Clicked URL",
  "userAgent": "Chrome (testing)",
  "ipAddress": "0.0.0.0"
}

• clickId – unique identifier for the click-through
• linkUrl – click-through URL
• userAgent – browser identifier from which the click-through originated.
• ipAddress – IP address from which the click-through originated.

Open rate in bulk email

{
  "guid": "8c857ad4-1e47-4b45-b656-80bb38f827e7",
  "webhookType": 12,
  "to": "test@boldem.cz",
  "from": "test@boldem.cz",
  "subject": "This is a 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 – browser identifier from which the click-through originated.

Soft bounce during bulk email dispatch

{
  "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 – unique identifier of the delivery failure information.
• statusCode – Status code from the mail server (e.g. 5.0.0).
• message – Message from the mail server (e.g., SMTP; 550 5.1.1 Sorry, no mailbox here by that name.)

Hard Bounce during bulk email dispatch

{
  "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 – unique identifier of the delivery failure information.
• statusCode – Status code from the mail server (e.g. 5.0.0).
• message – Message from the mail server (e.g., SMTP; 550 5.1.1 Sorry, no mailbox here by that name.)

Unsubscribed from bulk email

{
  "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 – unique identifier for unsubscribe information.
• userAgent – identifier of the browser from which the logout occurred.
• ipAddress – IP address from which the logout occurred

The bulk email was marked as 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 – identifier of the browser from which the report was submitted.
• ipAddress – IP address from which the report was submitted.