Bedrock | Webhook Documentation

Introduction

With webhooks it's possible to get notified when events occur in Lime Marketing. Typical events can be when an opt-in, opt-out, link click, opening, bounce etc. Webhook subscriptions can be managed via the API or via UI. A webhook subscription has a target endpoint URL where the event payload is posted. The payload can be sent as one request per event or in batches. The integrity of the payload can also be secured using a Hash-based Message Authentication Code. If there are temporary errors in the delivery of the webhook request multiple retries will be attempted before failing.

Events Configuration Available events Security

Events

When an event resulting in a webhook is triggered in Lime Marketing, it is eventually sent to all subscribers. There is no guarantee that the notifications arrive in order, so it is up to the receiver to filter, batch, and sort incoming requests.

Receiving

The event payload is sent as an HTTP POST request to the target endpoint URL. The payload is sent as JSON in the request body, and the content type is application/json. The payload is signed using a Hash-based Message Authentication Code (HMAC) to ensure the integrity of the payload. The signature is sent in the header bizwizard-signature and is a base64 encoded string of the HMAC SHA256 hash of the payload using the secret key as the key for the HMAC. The secret key is configured in the webhook subscription. The secret key is never sent in the request.

Example of a webhook request:

                                                                                                                                                                                                                                                                                                                                                              
content-type: application/json; charset=utf-8
bizwizard-appid: some app #(optional) configured on the subscription to identify which app the webhook is for
bizwizard-topic: automated_flow.action_executed # the event topic
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2 # id set by Lime Marketing to identify the event
bizwizard-signature: WZ41ZsjgqWbEBgg72GwlydSXozrw7dHhdccYOe6R17s= # (optional) signature created using the secret key
bizwizard-isbatched: 0 # the payload is batched
custom-header: some value # custom headers configured on the subscription
accept: application/json

{
  "Payload":"This differs depending on the event"
}

When a webhook isn't accepted by the target by responding with a success status code, it may be subject to retry if the status code is any of 408, 500, 502, 503, 504.

Retry schedule:

# 2 minutes 30 seconds
# 12 minutes 30 seconds
# 1 hour 2 minutes 30 seconds
# 5 hours 12 minutes 30 seconds
# 1 day 2 hours 2 minutes 30 seconds
# 5 days 10 hours 12 minutes 30 seconds

Batching

Webhooks can be configured to be batched to reduce the number of requests needed to transfer all event payloads. The payload is then modified to hold multiple webhook payloads in an array, and the header bizwizard-isbatched: 1 is set. The webhook topic is moved to the payload "EventTopic": "webhook.topic.name"

bizwizard-isbatched: 1

[
{
//payload webhook 1
"EventTopic": "webhook.topic.name"
},
{
//payload webhook 2
"EventTopic": "webhook.topic.name"
}
]

Note that if there aren't enough webhooks in the queue to batch them, a single normal webhook will be sent - the receiver needs support to handle both

Configuration

Manage subscriptions in the Lime Marketing

You can find the pages for managing webhook subscriptions under Settings -> Integrations -> Webhook Subscriptions.

Manage subscriptions via Bedrock API

Fetch a list of available webhook subscription packages

The actual events in Lime Marketing available for subscription are wrapped with a package. A package can include one or several topics. To retrieve all available packages, call GET api/webhooksubscriptionpackage. Save the list for later usage.

Create a new webhook subscription

Use POST api/webhooksubscription to create a new subscription.

AppId: If possible, create an account with an app id in the receiving application and configure it with this field.
Name: Select a name for the subscription. For example, the name of the receiving application.
Uri: The URI to the receiving application (endpoint).
DefaultHeaders: It is possible to configure extra default headers.
WebHookSubscriptionPackageNames: One or several subscription package names can be configured.
Secret: The secret key for the receiving application. This value is used as a shared secret. The field is not stored encrypted.

Edit or delete an existing subscription via Bedrock API

Update a subscription

Use PUT api/webhooksubscription to update an existing webhook subscription. The fields are the same as the POST method with an additional switch to pause or activate a subscription.

Retrieve subscriptions

Use GET api/webhooksubscription to retrieve all webhook subscriptions. Use GET api/webhooksubscription/ to retrieve a specific subscription.

Delete a subscription

To delete a subscription, use DELETE api/webhooksubscription.

Available events

Automated flow action executed
Automated flow deleted
AutomatedFlowParticipant added
Automated flow participant failed
Automated flow participant finished
Automated flow participant opt-out
Automated flow participant removed
Automated flow cleared
Automated flow started
Automated flow stopped
Event cancelled form response
Event form response
Event invitation mailmessage sent
Mail message bounced
Mail message bounced hard
Mail message link clicked
Mail message not sent to recipient
Mail message opened
Mail message send finished
Mail message send started
Mail message sent to recipient
Mail publication opt-in
Mail publication opt-out
Mail total opt-out
SMS message delivered to recipient
SMS message send finished
SMS message send started
SMS message sent to recipient
Survey form response
Transaction mail message bounced
Transaction mail message delivered
Transaction mail message link clicked
Transaction mail message not sent
Transaction mail message opened
Transaction mail message sent
Transaction SMS delivery failed
Transaction SMS delivery succeded
Transaction SMS sent

Automated flow action executed

automated_flow.action_executed

Get notified when an action has been executed

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.action_executed
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 79,
    "Name": "Name8b06ecdf-8e48-426b-8b10-ab51b2420410",
    "PublicationId": 234,
    "IsRunning": false,
    "Description": "Description50e0ce45-5752-4970-961a-90f6a7648d08"
  },
  "AutomatedFlowParticipant": {
    "Id": 105,
    "AutomatedFlowId": 147,
    "ParticipantData": [
      {
        "Name": "Name2f61d9df-2cb1-438f-a721-4d6602d07ded",
        "Value": {},
        "Type": "EMAIL",
        "Required": true
      },
      {
        "Name": "Name1735771e-9055-408d-b170-23e68feab43e",
        "Value": {},
        "Type": "NUMBER",
        "Required": false
      },
      {
        "Name": "Name8cb4339e-7491-4148-b359-b029245972d3",
        "Value": {},
        "Type": "DATETIME",
        "Required": true
      }
    ]
  },
  "AutomatedFlowAction": {
    "Id": "00000000-0000-0000-0000-000000000001",
    "Name": "",
    "FriendlyName": "friendlyName097ee165-c9ec-4d03-af7f-374caa5f1ad6",
    "ScheduledExecutionTime": "2023-09-06T17:42:41.8250509",
    "Type": "DELAY",
    "Version": 1
  },
  "NextAutomatedFlowAction": {
    "Id": "00000000-0000-0000-0000-000000000001",
    "Name": "",
    "FriendlyName": "friendlyName22508836-98e6-4f73-8901-28dfecc58aba",
    "ScheduledExecutionTime": "2024-11-26T03:32:39.8976018",
    "Type": "DELAY",
    "Version": 1
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId373e18d3-e14b-4057-98b9-a5434c5a8a0d",
    "ExternalPersonId": "ExternalPersonId997012fa-b5d8-493c-bf03-fd5817dcf7b9"
  },
  "StatusCode": 136,
  "StatusText": "StatusTextec4f6c00-f59d-4e01-a556-a55cee9e4b03",
  "Message": "Message16fe4be4-c4f9-40da-9ad9-f0d9d2788513",
  "EventRaisedUtcTimeStamp": "2024-12-19T22:25:53.1397531"
}

Automated flow deleted

automated_flow.deleted

Get notified when an Automated flow is deleted

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.deleted
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 32,
    "Name": "Nameeb15d61e-a3d7-4a96-8090-f6d0ba7fa275",
    "PublicationId": 129,
    "IsRunning": false,
    "Description": "Description0806e091-265b-424d-9bf2-83c07ba2f507"
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId7c82bf54-9c18-4655-9a1e-b819dabb8e96",
    "ExternalPersonId": "ExternalPersonId2bf06589-eb3e-4173-99dc-348a6690ac5c"
  },
  "EventRaisedUtcTimeStamp": "2025-08-24T20:37:31.4568789"
}

AutomatedFlowParticipant added

automated_flow.participant.added

Get notified when an AutomatedFlowParticipant is added to an AutomatedFlow

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.participant.added
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 32,
    "Name": "Name9ac9eb43-9337-4c79-8e36-ceee82b9c2dc",
    "PublicationId": 129,
    "IsRunning": false,
    "Description": "Descriptione0e567bb-f033-4c9a-9a69-de348d8cf28a"
  },
  "AutomatedFlowParticipant": {
    "Id": 48,
    "AutomatedFlowId": 151,
    "ParticipantData": [
      {
        "Name": "Namea62716d0-ea19-4be0-88fe-65c890e278b0",
        "Value": {},
        "Type": "EMAIL",
        "Required": true
      },
      {
        "Name": "Namecc7fa4d0-1a00-4fa2-842d-671bd325fb87",
        "Value": {},
        "Type": "NUMBER",
        "Required": false
      },
      {
        "Name": "Namea027e317-4fb0-4097-9c2a-dc158ecae750",
        "Value": {},
        "Type": "DATETIME",
        "Required": true
      }
    ]
  },
  "NextAutomatedFlowAction": {
    "Id": "00000000-0000-0000-0000-000000000001",
    "Name": "",
    "FriendlyName": "friendlyName4f4cbd49-5b16-4bf1-86cc-51bc7644159d",
    "ScheduledExecutionTime": "2025-08-24T20:37:31.4568789",
    "Type": "DELAY",
    "Version": 1
  },
  "AutomatedFlowTrigger": {
    "Id": 220,
    "Name": "Namee6730115-93cb-4ea3-957a-7adacb61ba1a",
    "AutomatedFlowId": 147,
    "TriggerIdentifier": "c8a49aae-0909-488d-8711-cb46c2fac4b1",
    "TriggerType": "TriggerType342c8463-32e0-4bdd-a31f-ea0be7042cc6"
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId6b71e1bb-39c7-4663-911c-d19caa97b7ec",
    "ExternalPersonId": "ExternalPersonId5221eb52-6b3d-4bc9-b203-5a7dd9246c9c"
  },
  "EventRaisedUtcTimeStamp": "2022-12-22T14:39:01.8037408"
}

Automated flow participant failed

automated_flow.participant.failed

Get notified when an Automated flow has failed to execute a participant action

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.participant.failed
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 249,
    "Name": "Name1deab014-303d-4c13-ad70-f690d0415a46",
    "PublicationId": 137,
    "IsRunning": false,
    "Description": "Description6848c680-02f4-43bf-858f-bbb466ee3661"
  },
  "AutomatedFlowParticipant": {
    "Id": 104,
    "AutomatedFlowId": 170,
    "ParticipantData": [
      {
        "Name": "Name39a0702d-3dc2-4e36-be43-c2cd8e9e37ec",
        "Value": {},
        "Type": "EMAIL",
        "Required": true
      },
      {
        "Name": "Namec32fcaa0-1c5b-4bb7-b1aa-91ac3f40a254",
        "Value": {},
        "Type": "NUMBER",
        "Required": false
      },
      {
        "Name": "Namedf78b1d5-7c3a-4b2a-9b24-4adbc80557b1",
        "Value": {},
        "Type": "DATETIME",
        "Required": true
      }
    ]
  },
  "AutomatedFlowAction": {
    "Id": "00000000-0000-0000-0000-000000000001",
    "Name": "",
    "FriendlyName": "friendlyName142dec07-6b66-43bb-82c7-6b2f1959c8aa",
    "ScheduledExecutionTime": "2025-12-19T20:45:28.6694227",
    "Type": "DELAY",
    "Version": 1
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIdd4d48e1f-5ebc-4b75-aca6-c97bafa9ecfc",
    "ExternalPersonId": "ExternalPersonIdec18fd2d-d4b8-4f2a-beae-e431af2c2d45"
  },
  "EventRaisedUtcTimeStamp": "2026-03-19T22:01:19.0286351"
}

Automated flow participant finished

automated_flow.participant.finished

Get notified when a participant has passed the last action in an Automated flow

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.participant.finished
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 202,
    "Name": "Name3c3ea535-1ab5-4a30-bfcc-fd1dca748392",
    "PublicationId": 31,
    "IsRunning": false,
    "Description": "Description8648c4e1-4a8b-4213-b43b-469325791ab6"
  },
  "AutomatedFlowParticipant": {
    "Id": 47,
    "AutomatedFlowId": 175,
    "ParticipantData": [
      {
        "Name": "Name3c74a3ee-cec1-4072-b63f-be76d2788f29",
        "Value": {},
        "Type": "EMAIL",
        "Required": true
      },
      {
        "Name": "Name4f8635b5-2082-41e9-a0c9-794a6f2e106f",
        "Value": {},
        "Type": "NUMBER",
        "Required": false
      },
      {
        "Name": "Name91b1f7b9-5abd-4a96-8502-224cd2668071",
        "Value": {},
        "Type": "DATETIME",
        "Required": true
      }
    ]
  },
  "AutomatedFlowAction": {
    "Id": "00000000-0000-0000-0000-000000000001",
    "Name": "",
    "FriendlyName": "friendlyNameb272d86e-8b61-40bd-b0d8-c5b54377c9bd",
    "ScheduledExecutionTime": "2026-02-18T22:43:56.3765914",
    "Type": "DELAY",
    "Version": 1
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId9e7a4849-d652-48f1-b833-cb0cc9bb9f2f",
    "ExternalPersonId": "ExternalPersonId450f2fdf-4570-4bbd-b2a1-8a388eb5ecfe"
  },
  "EventRaisedUtcTimeStamp": "2022-06-28T14:58:14.2323357"
}

Automated flow participant opt-out

automated_flow.participant.opt_out

Get notified when a participant opts-out of an Automated flow

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.participant.opt_out
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 249,
    "Name": "Namec1e7e89b-b292-44fc-9512-431c79affa9e",
    "PublicationId": 137,
    "IsRunning": false,
    "Description": "Description7326e7a0-04b9-406a-9683-ff2fda091c9a"
  },
  "AutomatedFlowParticipant": {
    "Id": 104,
    "AutomatedFlowId": 170,
    "ParticipantData": [
      {
        "Name": "Name15ca43e8-b7e2-4521-b52e-f1d7ad23a32c",
        "Value": {},
        "Type": "EMAIL",
        "Required": true
      },
      {
        "Name": "Nameea66e66c-0ff8-4b41-b5eb-08e200e2988d",
        "Value": {},
        "Type": "NUMBER",
        "Required": false
      },
      {
        "Name": "Name544f3747-512e-43a6-b206-607d79559d8e",
        "Value": {},
        "Type": "DATETIME",
        "Required": true
      }
    ]
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId7eb780dc-8dad-4f59-a30f-5cb5a72992c7",
    "ExternalPersonId": "ExternalPersonId2f368bb1-12c2-43a1-98a8-20dcdcbd803f"
  },
  "EventRaisedUtcTimeStamp": "2025-12-19T20:45:28.6694227"
}

Automated flow participant removed

automated_flow.participant.removed

Get notified when a participant is removed from an Automated flow

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.participant.removed
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 249,
    "Name": "Name8d67dde8-0dbd-4891-8891-fe6e80fb874c",
    "PublicationId": 137,
    "IsRunning": false,
    "Description": "Descriptiond87de251-40df-4198-b0a4-03449830a4e7"
  },
  "AutomatedFlowParticipant": {
    "Id": 104,
    "AutomatedFlowId": 170,
    "ParticipantData": [
      {
        "Name": "Namec06b78eb-af8c-4806-b9bb-f58cd55374c8",
        "Value": {},
        "Type": "EMAIL",
        "Required": true
      },
      {
        "Name": "Namea48e1dbf-1b82-487e-a0c2-57a5ecc2c040",
        "Value": {},
        "Type": "NUMBER",
        "Required": false
      },
      {
        "Name": "Name15945666-5c6b-4910-9c8d-9d76d77e9c13",
        "Value": {},
        "Type": "DATETIME",
        "Required": true
      }
    ]
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIdbe28c1fe-484f-4a6b-ab23-2de3d17965d3",
    "ExternalPersonId": "ExternalPersonId592acd4c-cd7b-41a6-8de0-04b91160aee6"
  },
  "EventRaisedUtcTimeStamp": "2025-12-19T20:45:28.6694227"
}

Automated flow cleared

automated_flow.participants.cleared

Get notified when all partcipants are cleared by an administrator from an Automated flow

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.participants.cleared
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 249,
    "Name": "Name5314f573-c168-4a45-9e10-af41f776ffd5",
    "PublicationId": 137,
    "IsRunning": false,
    "Description": "Descriptionf90f399e-ce7a-4b73-8878-cce991540d63"
  },
  "AutomatedFlowParticipantProperties": [
    {
      "Id": 170,
      "Name": "Name27745928-32da-4c8d-b0f6-3dd9fa34b735",
      "Required": true,
      "Unique": false,
      "DataType": "DataType3d192688-e793-4e4c-81a3-c4db957386b7"
    },
    {
      "Id": 17,
      "Name": "Nameca7826fb-fe03-44b4-b85e-3a9698f50048",
      "Required": true,
      "Unique": false,
      "DataType": "DataTypea099ec76-bc67-4ea1-9176-36d69a32d7e9"
    },
    {
      "Id": 50,
      "Name": "Namee1a5ba7f-4dfc-4155-9f45-d256edd88d74",
      "Required": true,
      "Unique": false,
      "DataType": "DataType53123b99-f5bb-4849-8755-3196e8eede15"
    }
  ],
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId963280a1-ede4-48c6-b18e-8918372b9657",
    "ExternalPersonId": "ExternalPersonIdaf74c4e6-3577-452b-a1a8-e66328d4a572"
  },
  "EventRaisedUtcTimeStamp": "2025-12-19T20:45:28.6694227"
}

Automated flow started

automated_flow.started

Get notified when an Automated flow is started

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.started
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 154,
    "Name": "Namecd4deea5-4372-40f2-879a-de6ab39d8b83",
    "PublicationId": 218,
    "IsRunning": false,
    "Description": "Descriptionf5d3909b-bdd8-488d-a03e-13e659051524"
  },
  "AutomatedFlowParticipantProperties": [
    {
      "Id": 110,
      "Name": "Name7f136628-1261-4940-9e0d-0d6061a60d8d",
      "Required": true,
      "Unique": false,
      "DataType": "DataType1b919366-9efa-4d53-ba15-6ef19ee50487"
    },
    {
      "Id": 91,
      "Name": "Namecf153675-1739-4c76-b0f4-838713b59166",
      "Required": true,
      "Unique": false,
      "DataType": "DataTypeba8057f9-522e-4c72-9f33-097da1234760"
    },
    {
      "Id": 26,
      "Name": "Name22f40936-2344-4210-966b-5434a1675ad8",
      "Required": true,
      "Unique": false,
      "DataType": "DataType074612e0-e1c5-4f9f-867e-3c6a2e5a4767"
    }
  ],
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId99c0c647-334f-47aa-b696-1920ccf6c122",
    "ExternalPersonId": "ExternalPersonId515984c0-65c3-4a74-bb12-1cde6043b47f"
  },
  "EventRaisedUtcTimeStamp": "2023-05-18T17:16:54.4498962"
}

Automated flow stopped

automated_flow.stopped

Get notified when an Automated flow is stopped

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: automated_flow.stopped
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "AutomatedFlow": {
    "Id": 32,
    "Name": "Name9e5d5512-0f1c-4cad-b7fa-fa3e2dba7cf1",
    "PublicationId": 129,
    "IsRunning": false,
    "Description": "Description4116fa32-314a-4342-9a51-34a8ffe9be53"
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId46937ca1-a19c-4e9a-9ca6-75e3387cba38",
    "ExternalPersonId": "ExternalPersonIdd931aea1-f783-4e92-8a4a-392e005a3a85"
  },
  "EventRaisedUtcTimeStamp": "2025-08-24T20:37:31.4568789"
}

Event cancelled form response

event.cancelled.form_response

Get notified when a person cancels their form registration.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: event.cancelled.form_response
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "Event": {
    "Id": 177,
    "Name": "Name45742722-af2e-4416-a142-6486cf46a5d3"
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId81a3f9be-a923-4b45-8a0a-69977819038b",
    "ExternalPersonId": "ExternalPersonId97777e23-cc51-43af-85d1-d4a12b9eda73"
  },
  "ResponseWasUpdated": true,
  "MailRecipient": {
    "Id": 207,
    "Email": "f6106@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "Form": {
    "Id": 115,
    "Name": "Nameecc25fed-d875-44b7-814d-8e07131a508c",
    "FormType": "EVENT | SURVEY | RECIPIENTPAGE_ACCESS | RECIPIENTPAGE_EDIT | SUBSCRIPTION",
    "FormResponseId": 79,
    "FormFieldValues": [
      {
        "Id": 66,
        "Name": "Name8dea28fa-b776-4072-838a-c3209ff896af",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Value6a521bf0-16f5-468f-b375-c89d525d2863",
        "Values": [
          "46c2c47d-9b12-4cfd-b6af-a70303c36422",
          "5f773bb3-61dd-4f99-82e7-59a223750437",
          "f9f9d396-1300-413e-afce-09b17d7cae50"
        ],
        "FieldLabel": "FieldLabel22d8f3e2-573a-4bcf-968c-becb3f8936f6",
        "ValueOptions": [
          {
            "Value": "value84e0921b-1ccc-4e0f-ba95-f8633906fa3f",
            "Label": "labeld968f3a5-de30-4cd6-9f53-be69e9d0b7c6"
          },
          {
            "Value": "value8674d648-5b66-4555-bb15-037554fe2f20",
            "Label": "labelfadba4cd-721e-4645-bd61-ca78eea1e71c"
          },
          {
            "Value": "value1b7d7662-480c-4c2a-9022-3ca93bba26db",
            "Label": "label632877c8-c4cd-49bd-aa9f-870ea10957a8"
          }
        ],
        "FormFieldDataType": "FormFieldDataType8398b024-2780-4070-86ed-6714e08dafad"
      },
      {
        "Id": 36,
        "Name": "Name3a2bdd40-2056-4927-a89a-bf5bff67a028",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Value782c174d-81cd-4749-b89d-d9db77b6af8a",
        "Values": [
          "3ce63ed2-e04a-4143-99af-fdd8fe44aac1",
          "d89a2468-bfed-4392-bd02-f068b432a80c",
          "cbe7ac5f-12d4-4a73-91e3-90e49bb798cc"
        ],
        "FieldLabel": "FieldLabelf395d3aa-569c-4852-9d8f-0e56a911d90e",
        "ValueOptions": [
          {
            "Value": "valuefa961f0c-419e-4326-b19c-97f07085b1bf",
            "Label": "labelbde94488-5f55-4b3b-a70f-0b53ac28935e"
          },
          {
            "Value": "valuea38b970a-7919-4cba-8a5e-1a3af189314d",
            "Label": "label0272ee38-09de-4e66-8228-b596c0dec283"
          },
          {
            "Value": "value946f5fff-614e-471b-8e5c-53a8140d958a",
            "Label": "labelbc7b9d25-20c5-425c-9b57-5aa2f6abf78c"
          }
        ],
        "FormFieldDataType": "FormFieldDataTypef3e435ea-ea07-4c59-abd1-2a8e39535548"
      },
      {
        "Id": 246,
        "Name": "Name1c9680c2-7cbe-40aa-86a0-cc3401ec86c7",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Valueb21e56e2-c511-451d-b956-f462eaf85b38",
        "Values": [
          "38cb0807-1bff-4393-9a2d-c158dc8a9146",
          "a2646b29-ae34-4838-bf8b-f0d068670393",
          "ed3df6ea-8a67-411d-85d9-f8e65e0aaea1"
        ],
        "FieldLabel": "FieldLabel7b8b50bf-f490-423d-814b-32c7311f5c1e",
        "ValueOptions": [
          {
            "Value": "valuef02e99fa-bc3c-4713-a6fc-a0b6b83724c7",
            "Label": "label62101552-eedd-4fd9-92c2-9a26ecbbcf08"
          },
          {
            "Value": "value52cfcc92-04de-4293-a5e9-00561fc52f5b",
            "Label": "label0b1d72c9-d1ab-411f-b1cd-eaa7536935c4"
          },
          {
            "Value": "valued0fee6d8-28dc-4ac2-a10a-1d0e29330b63",
            "Label": "label48057654-c563-48be-bc97-b6b801480c6e"
          }
        ],
        "FormFieldDataType": "FormFieldDataType46d0119f-2e5b-443c-9162-0d9ca041b3d7"
      }
    ],
    "FormFields": [
      {
        "Id": 212,
        "Name": "Name65856e24-34b3-4bd0-894c-edd6506381d3",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabelf31c125c-dbb2-4708-9ae0-86e146c30375",
        "FormFieldDataType": "FormFieldDataType076ce755-e086-483b-abf0-4556a70428de"
      },
      {
        "Id": 243,
        "Name": "Nameb29c4ac6-1aa3-4821-88b3-633fab8f6e47",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabel1527a909-bd21-496f-80a0-a5af8a60bb01",
        "FormFieldDataType": "FormFieldDataType4f4b3638-9a6e-4896-aa6c-ba7fb9be3084"
      },
      {
        "Id": 7,
        "Name": "Name7425e4b1-3900-4ec6-a0bf-c50a54faaa33",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabelc9d0a091-be86-4830-a263-6c975a43765f",
        "FormFieldDataType": "FormFieldDataTypeb4bc1506-8f3c-4315-b878-c90beb206e81"
      }
    ]
  },
  "FormResponseType": "Default | IsMaxAnswer | EventEnrolled | EventDeclined | EventCancelled | EventParticipated | SurveyRegistration | MultiOptin | PublicationOptIn | RecipientPageAccess | RecipientPageEdit",
  "EventRaisedUtcTimeStamp": "2023-03-05T20:42:57.9150414"
}

Event form response

event.form_response

Get notified when an event form response is submitted.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: event.form_response
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "Event": {
    "Id": 230,
    "Name": "Name06e347fc-88d2-4758-a9e4-d8bd243b3bd0"
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId670d9018-8f8c-46bd-af94-46a1e1c43ea0",
    "ExternalPersonId": "ExternalPersonId68f436c6-5097-45b5-8e90-87f3d76499d3"
  },
  "ResponseWasUpdated": true,
  "MailRecipient": {
    "Id": 189,
    "Email": "39175@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "Form": {
    "Id": 243,
    "Name": "Name832d9930-f75d-4b63-879d-6b92c23f3bad",
    "FormType": "EVENT | SURVEY | RECIPIENTPAGE_ACCESS | RECIPIENTPAGE_EDIT | SUBSCRIPTION",
    "FormResponseId": 150,
    "FormFieldValues": [
      {
        "Id": 246,
        "Name": "Name0e8cf560-5a13-405b-891d-83ecaeb53acd",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Value42c8f763-7081-4414-b7a8-1c1ba6638b5e",
        "Values": [
          "868e5464-c741-4e3e-af5d-c8d555a58613",
          "50b5288c-5449-4ed8-8535-28166c3dd6c1",
          "e36f330d-17a0-4dce-856d-943ad1ef0e81"
        ],
        "FieldLabel": "FieldLabelc5ba4307-e5c8-4ce7-b617-a26fccfd50f9",
        "ValueOptions": [
          {
            "Value": "valueb46b4eb0-a29b-4312-ad28-ede15440554b",
            "Label": "label46a26542-b519-4dd9-8611-3420c79743c3"
          },
          {
            "Value": "valueddd1e208-9e60-41c6-bf2e-8e9cc19478ef",
            "Label": "label99a44b7e-e48b-4637-982d-0eef33b32468"
          },
          {
            "Value": "value14897403-e046-4466-a290-797b242ee23b",
            "Label": "label64ba6241-752e-4af8-8084-dbf7845d29ee"
          }
        ],
        "FormFieldDataType": "FormFieldDataType87c8fd5e-d62b-4aa6-9956-e38791853e0a"
      },
      {
        "Id": 199,
        "Name": "Named283bde6-a267-412f-ae8e-e8baf82a1544",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Valuecb003cac-5d07-4cf1-91e0-843f59470f41",
        "Values": [
          "527731fc-9a38-4335-bee3-745f503e8402",
          "72d201f4-0a8a-43ec-ac4b-af21877cf55b",
          "92542466-418e-47a6-8d02-eba256d48667"
        ],
        "FieldLabel": "FieldLabel14c551e1-a7f6-450b-b3ad-70079a481839",
        "ValueOptions": [
          {
            "Value": "valuef85b2d32-2f8a-4738-91e3-b247ca174c85",
            "Label": "label274c23e2-c084-4f1f-bb0d-fd5498e055f8"
          },
          {
            "Value": "value7dc80e6e-a027-43a1-92a2-8da1e7f3b907",
            "Label": "label0d4788f6-927e-48c3-a88e-20af87f96c43"
          },
          {
            "Value": "value18139894-123a-4fd0-b86e-7b747f92425e",
            "Label": "labeld967409f-63c4-4194-abb6-6d2bce1435d1"
          }
        ],
        "FormFieldDataType": "FormFieldDataTypedacc2623-44df-4a32-b42e-49b1b760aec5"
      },
      {
        "Id": 27,
        "Name": "Name3ff72b13-5de1-4b68-a985-e68a4cb7769d",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Valuef6ebdb1c-3e1d-49ef-b284-642ffb7871e0",
        "Values": [
          "15f23900-15b2-4fb3-90ed-229b1e80b2e0",
          "55e90742-48f1-44fe-ba0e-90cd454ae1f3",
          "0d698dfc-76c5-4a03-b015-7d5486d15544"
        ],
        "FieldLabel": "FieldLabel1cb96708-9975-4780-8558-eb78b21d7320",
        "ValueOptions": [
          {
            "Value": "valuef916a8d0-d6c9-44fc-a942-52e1a9db5cee",
            "Label": "label8aed03c0-5d1c-4057-bed8-0a249ee96a52"
          },
          {
            "Value": "valuee0e61d75-10ef-41dc-ad76-0c15aca6fc67",
            "Label": "label597795f2-e49b-4c77-ba09-d6db98cb1d67"
          },
          {
            "Value": "valueeef003ed-136c-4a50-9a5f-a530e31906e0",
            "Label": "labele2c43a90-48d1-42e1-b1ef-efcc39624e8f"
          }
        ],
        "FormFieldDataType": "FormFieldDataType5f496a74-514d-4346-910c-55de45d7237e"
      }
    ],
    "FormFields": [
      {
        "Id": 154,
        "Name": "Namea47941e5-fbd4-4088-a40c-9cb62f2bf491",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabelf3e187bd-2be9-4e17-b538-ac79b5979ed1",
        "FormFieldDataType": "FormFieldDataTyped33b7965-c262-4af4-bbc4-923dd1d09b8c"
      },
      {
        "Id": 248,
        "Name": "Name10114f92-3f39-4c7a-8351-655db0602931",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabel0ce6c32f-f6b1-406a-8c5f-4a7c8c1bb2a9",
        "FormFieldDataType": "FormFieldDataTypebadb08e7-b906-45e3-906d-715208c444e4"
      },
      {
        "Id": 35,
        "Name": "Nameb3723d97-8e53-41c4-9215-09ea7de75565",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabel2156cb5b-6d2f-4c40-9397-7e363f4d2222",
        "FormFieldDataType": "FormFieldDataType22476383-afd8-405c-934a-c2fdf4f38a13"
      }
    ]
  },
  "FormResponseType": "Default | IsMaxAnswer | EventEnrolled | EventDeclined | EventCancelled | EventParticipated | SurveyRegistration | MultiOptin | PublicationOptIn | RecipientPageAccess | RecipientPageEdit",
  "EventRaisedUtcTimeStamp": "2025-12-13T20:56:10.9605712"
}

Event invitation mailmessage sent

event.invitation_mail_message.sent

Get notified when an event invitation mail message is sent. An event invitation mail message is any mail message containing an invitation link to an event.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: event.invitation_mail_message.sent
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIddcd56dd7-7874-4902-9c97-8a441ce84bbb",
    "ExternalPersonId": "ExternalPersonIddaec6d06-37ab-448b-835c-40033c161358"
  },
  "MailMessageQueue": {
    "Id": 204,
    "FromEmailAddress": "84f06@bwz.se",
    "FromName": "FromNamead8b3ee1-4b67-4c37-a4d0-a835a6e02eca",
    "ReplyToEmailAddress": "f95e8@bwz.se",
    "Subject": "Subjectaf9fae44-8268-4ee3-91ed-a1995ba0540b",
    "SendDate": "2022-11-04T17:13:23.5469431"
  },
  "MailMessage": {
    "Id": 235,
    "Name": "Nameb7023d21-f194-45ae-93d4-48ace25e228d"
  },
  "Publication": {
    "Id": 191,
    "Name": "Name2e4475a9-0fd0-48a1-ab01-a209c58ca87b"
  },
  "MailRecipient": {
    "Id": 99,
    "Email": "58e43@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "Event": {
    "Id": 201,
    "Name": "Name2050ecc3-570c-4f74-9ca8-d62eafd99e35"
  },
  "EventRaisedUtcTimeStamp": "2024-05-18T05:31:59.1451858"
}

Mail message bounced

mail.message.bounced

Get notified when a mail message bounced. This event is triggered for all types of bounces except hard bounces

Info about bounce types

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.message.bounced
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId1ed3e9c0-2de9-4002-925a-10878ddb483b",
    "ExternalPersonId": "ExternalPersonId48f59437-60a8-4b9d-8e9a-f7c35eba6c4d"
  },
  "MailRecipient": {
    "Id": 107,
    "Email": "3c80f@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "Publication": {
    "Id": 4,
    "Name": "Namee7b9d1f0-e24b-4903-864c-c51ed77779a3"
  },
  "MailMessageQueue": {
    "Id": 77,
    "FromEmailAddress": "c24f4@bwz.se",
    "FromName": "FromName1cb1536d-89cf-4210-b117-bdea2234145d",
    "ReplyToEmailAddress": "c82cd@bwz.se",
    "Subject": "Subject74e45397-c797-48fb-a0d6-bb6db372c1c3",
    "SendDate": "2022-09-11T17:22:36.4193652"
  },
  "MailMessage": {
    "Id": 209,
    "Name": "Name823de368-6406-4dad-bf30-a89c77a900b3"
  },
  "MailBounce": {
    "BounceType": "TRANSIENT | UNSUBSCRIBE | SUBSCRIBE | AUTO_RESPONDER | ADDRESS_CHANGE | DNS_ERROR | SPAM_NOTIFICATION | OPEN_RELAY_TEST | UNKNOWN | SOFT_BOUNCE | VIRUS_NOTIFICATION | CHALLENGE_VERIFICATION",
    "Description": "Description436826f3-1cc8-409e-adeb-e1f3f8d98742",
    "BounceDate": "2022-09-06T13:02:23.1381145"
  },
  "EventRaisedUtcTimeStamp": "2025-10-30T14:53:18.5955076"
}

Mail message bounced hard

mail.message.bounced_hard

Get notified when a mail message bounced hard. This event is only triggered for hard bounces (mailbox not found etc)

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.message.bounced_hard
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIdbcf51516-403a-4c39-a679-4f548af1a3de",
    "ExternalPersonId": "ExternalPersonIdd22afe13-7f1f-4cae-b3c2-1e37cc9e782a"
  },
  "MailMessage": {
    "Id": 212,
    "Name": "Name0670b965-a723-4033-b36b-0f5d2813e525"
  },
  "MailMessageQueue": {
    "Id": 253,
    "FromEmailAddress": "ed960@bwz.se",
    "FromName": "FromNamee9f19dbe-2085-4e1a-af75-84193b2c2116",
    "ReplyToEmailAddress": "3e884@bwz.se",
    "Subject": "Subjecta3b5be5a-b98f-4a30-a121-9f02ee3691fe",
    "SendDate": "2026-01-29T18:03:09.6090086"
  },
  "Publication": {
    "Id": 84,
    "Name": "Name5bb1317d-1ccb-4114-ae16-33e7c2b43d93"
  },
  "MailRecipient": {
    "Id": 183,
    "Email": "6ff37@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "MailBounce": {
    "Description": "Description679bd59b-5545-4cd4-9820-f6ebfe0aff36",
    "BounceDate": "2026-01-25T08:50:32.323041"
  },
  "EventRaisedUtcTimeStamp": "2024-08-20T04:23:39.1550762"
}

Mail message link clicked

mail.message.link_clicked

Get notified when a mail message link is clicked.

Info about link types

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.message.link_clicked
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId6bbdc0d5-7d95-4420-b1d5-542927cc314f",
    "ExternalPersonId": "ExternalPersonIdb8e4c69c-a31d-4b8e-99c2-f1731cc8edce"
  },
  "MailMessage": {
    "Id": 212,
    "Name": "Namee83fea4e-3fe9-4e4d-b6c5-970eaf3436b3"
  },
  "MailMessageQueue": {
    "Id": 253,
    "FromEmailAddress": "b32d8@bwz.se",
    "FromName": "FromName4b97a811-9be5-401b-9d2b-2d5b1347af07",
    "ReplyToEmailAddress": "6eba8@bwz.se",
    "Subject": "Subject7d361e95-872f-4a86-a052-e37929fd1ea9",
    "SendDate": "2026-01-29T18:03:09.6090086"
  },
  "Publication": {
    "Id": 84,
    "Name": "Name62705638-43ad-405a-b5a3-b01c8f4aef54"
  },
  "MailRecipient": {
    "Id": 183,
    "Email": "e618c@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "LinkCategory": {
    "Id": 34,
    "Name": "name096261c2-f681-42e9-ba68-eb7498888c1a"
  },
  "LinkUrl": "https://app.bwz.se/example/5ec32",
  "LinkName": "Contact me",
  "LinkValue": 123,
  "LinkType": "External | Survey | Event | PublicationOptIn | Special | MailTo | Calendar | FormResponse | GoogleMaps | UserFile | Barcode | Webpage | ConfirmOptIn | RecipientPage | ConfirmRecipientPageAccessForm | UpdateRecipientOptInStatus | ViewTicket | MultiOptin | CancelFormResponse | TicketParticipatedFormResponse | ViewSpecialLink | ViewAutomatedFlowOptOutPage | ConfirmAutomatedFlowOptOut",
  "EventRaisedUtcTimeStamp": "2022-08-28T11:56:47.2784225"
}

Mail message not sent to recipient

mail.message.not_sent_to_recipient

Get notified when a mail message wasn't sent to a recipient and the reason for not sending it.

Info about not sent reasons

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.message.not_sent_to_recipient
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "MailMessageQueue": {
    "Id": 54,
    "FromEmailAddress": "66e4a@bwz.se",
    "FromName": "FromNamed63829e3-89e1-47fa-aa52-39721076f2c7",
    "ReplyToEmailAddress": "b76b4@bwz.se",
    "Subject": "Subject80bf451c-e895-456c-a9a7-4e47196e29d3",
    "SendDate": "2023-03-10T16:54:15.0314764"
  },
  "MailRecipient": {
    "Id": 40,
    "Email": "760cc@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "Reason": 103,
  "ReasonText": "NOT_SENT_DUE_TO_SHARED_BLOCK_LIST | NOT_SENT_DUE_TO_OPTOUT | NOT_SENT_DUE_TO_BOUNCECOUNT",
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIddfefd628-2042-4964-9e32-038af4d8c102",
    "ExternalPersonId": "ExternalPersonId9eff391d-4956-447c-bf67-610d60c62e5b"
  },
  "MailMessage": {
    "Id": 52,
    "Name": "Name51ef5064-df92-4f51-b767-163ef8e210ca"
  },
  "Publication": {
    "Id": 11,
    "Name": "Name0472c91a-c079-4262-8732-343a8ee486c9"
  },
  "EventRaisedUtcTimeStamp": "2022-12-24T16:57:31.9042059"
}

Mail message opened

mail.message.opened

Get notified when a mail message is opened.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.message.opened
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIdf2044cd9-86bb-494e-b891-d66c072df7f4",
    "ExternalPersonId": "ExternalPersonIdf874f30d-38ad-4a10-b1d0-60881da33642"
  },
  "MailMessageQueue": {
    "Id": 212,
    "FromEmailAddress": "4690b@bwz.se",
    "FromName": "FromName973ee698-64c3-4750-9ae8-caf733d9781d",
    "ReplyToEmailAddress": "c5e1f@bwz.se",
    "Subject": "Subject947ded09-456d-4d41-afdd-25836fc28199",
    "SendDate": "2026-01-29T18:03:09.6090086"
  },
  "MailMessage": {
    "Id": 253,
    "Name": "Name9563cdd0-75ed-427f-b4ab-b123222d3e5a"
  },
  "Publication": {
    "Id": 84,
    "Name": "Name58613c1e-3901-402c-a0d7-26d0018ece40"
  },
  "MailRecipient": {
    "Id": 183,
    "Email": "e146f@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "EventRaisedUtcTimeStamp": "2022-08-28T11:56:47.2784225"
}

Mail message send finished

mail.message.send_finished

Get notified when a mail message send operation has finished. Only triggered once regardless of how many recipients the mail message has.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.message.send_finished
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIdad9be95e-2488-47a5-9108-d382159dbb4d",
    "ExternalPersonId": "ExternalPersonIdbf6941ed-6d52-4d9e-a1b2-e5521c65f519"
  },
  "MailMessageQueue": {
    "Id": 188,
    "FromEmailAddress": "15c3b@bwz.se",
    "FromName": "FromName6f62ea68-7b52-49fb-bc3b-31e1f72cfa08",
    "ReplyToEmailAddress": "0c41e@bwz.se",
    "Subject": "Subject62fdfca6-f7a7-459a-bba6-a502259e97bf",
    "SendDate": "2023-10-20T09:41:12.3568026"
  },
  "MailMessage": {
    "Id": 198,
    "Name": "Name60b7a4be-6430-4756-99ef-0fe72316c390"
  },
  "Publication": {
    "Id": 151,
    "Name": "Name9e97030d-caa9-4435-93d2-f43bb453f76d"
  },
  "ViewMessageHtmlLink": "https://app.bwz.se/example/eada7",
  "ViewMessageTextLink": "https://app.bwz.se/example/8c8b0",
  "ViewStatisticsLink": "https://app.bwz.se/example/48df3",
  "EventRaisedUtcTimeStamp": "2024-03-01T05:30:19.5003061"
}

Mail message send started

mail.message.send_started

Get notified when a mail message send operation has started. Only triggered once regardless of how many recipients the mail message has.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.message.send_started
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIdc299827e-ecbd-4e45-bf8c-fe7f91b22ebb",
    "ExternalPersonId": "ExternalPersonIdcce5d728-c1ef-48f0-9809-a258ec7637e1"
  },
  "MailMessageQueue": {
    "Id": 188,
    "FromEmailAddress": "3df3f@bwz.se",
    "FromName": "FromName0508d30d-2271-43c3-b65f-e80fedd7e21b",
    "ReplyToEmailAddress": "87805@bwz.se",
    "Subject": "Subjecta50cfc9a-bb4a-4ce5-945a-d3bfdabeeaaa",
    "SendDate": "2023-10-20T09:41:12.3568026"
  },
  "MailMessage": {
    "Id": 198,
    "Name": "Nameb771668e-a525-4014-9a2a-b0f0faf969e5"
  },
  "Publication": {
    "Id": 151,
    "Name": "Name5fd388a5-f0d4-40ac-a699-651578641e7f"
  },
  "ViewMessageHtmlLink": "https://app.bwz.se/example/cfe48",
  "ViewMessageTextLink": "https://app.bwz.se/example/f22b6",
  "ViewStatisticsLink": "https://app.bwz.se/example/c44b7",
  "EventRaisedUtcTimeStamp": "2024-03-01T05:30:19.5003061"
}

Mail message sent to recipient

mail.message.sent_to_recipient

Get notified when a mail message is sent to a recipient.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.message.sent_to_recipient
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId664a01b8-687b-4cc6-aea0-781e07dd2a75",
    "ExternalPersonId": "ExternalPersonId3cb5f54b-a647-49fc-8098-80349cfb5c9c"
  },
  "MailMessageQueue": {
    "Id": 188,
    "FromEmailAddress": "61e71@bwz.se",
    "FromName": "FromName4000a2fa-3e5d-4adc-9288-d6653902b6c3",
    "ReplyToEmailAddress": "78c81@bwz.se",
    "Subject": "Subjectba95d363-6441-4909-8daf-712f0eb6b1be",
    "SendDate": "2023-10-20T09:41:12.3568026"
  },
  "MailMessage": {
    "Id": 198,
    "Name": "Name794fcc07-dd5d-4fe0-bd46-08858a7161fe"
  },
  "Publication": {
    "Id": 151,
    "Name": "Name761aaf7d-da7d-44a1-befd-d8e4bf466607"
  },
  "MailRecipient": {
    "Id": 185,
    "Email": "6abe1@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "EventRaisedUtcTimeStamp": "2024-03-01T05:30:19.5003061"
}

Mail publication opt-in

mail.publication.opt_in

Get notified when an email address opt-in for a publication.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.publication.opt_in
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "Publication": {
    "Id": 148,
    "Name": "Name905c06d6-443e-4954-b6f8-8596ae3bfb83"
  },
  "MailRecipient": {
    "Id": 64,
    "Email": "2a73b@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "ResponseWasUpdated": true,
  "Form": {
    "Id": 37,
    "Name": "Name1c817754-9ef4-4ad5-8222-2f495bc242a4",
    "FormType": "EVENT | SURVEY | RECIPIENTPAGE_ACCESS | RECIPIENTPAGE_EDIT | SUBSCRIPTION",
    "FormResponseId": 13,
    "FormFieldValues": [
      {
        "Id": 34,
        "Name": "Name97a70d68-8504-40d8-b503-e7a5c5777e9a",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Value89a05f22-839d-43e4-b54c-6de4815bae07",
        "Values": [
          "8b2bb8e2-e8ab-4c08-bc3b-aaed64e2a6e0",
          "9f01df9b-4d6c-45e8-9c3f-6d1d6cd132d5",
          "0f0af2c3-ec2a-469e-beb5-16c0477eaeb8"
        ],
        "FieldLabel": "FieldLabel5f361f5e-6723-4a34-9a4b-8db33f69d9ce",
        "ValueOptions": [
          {
            "Value": "valuef33a1218-b0d1-4ef7-9580-0cc8463e5acd",
            "Label": "label03b24572-db88-419d-9300-4bb972c433e0"
          },
          {
            "Value": "value98ae75f2-2abf-41c1-a0c5-326c73207e43",
            "Label": "label8cb21954-ba39-4101-b81e-ea07d8251259"
          },
          {
            "Value": "value4b5a1faa-0abf-4d63-9a7e-0377620c65d6",
            "Label": "label2636bb19-9a08-4cfe-9e1a-861d0b2b4290"
          }
        ],
        "FormFieldDataType": "FormFieldDataTyped7479293-785d-4c75-95bf-525cc34ae805"
      },
      {
        "Id": 90,
        "Name": "Name92da5a2d-371f-4596-9b6d-f0a03f484132",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Valuea2d47eb3-b1bc-48cb-9ea7-bf2159b4f357",
        "Values": [
          "aa9fe71a-3acf-4eee-bdd8-67091190bb98",
          "e196b6ef-75c5-47dc-9a14-5520389a5c1e",
          "382ac46f-1735-4e6c-850b-0287eef66377"
        ],
        "FieldLabel": "FieldLabel3bc25b72-f87d-49b7-b375-134e2733f3cc",
        "ValueOptions": [
          {
            "Value": "value6b0b0aee-fe72-47f3-9103-b0ffddfa7b0d",
            "Label": "label1863e903-b877-43cb-8f8f-ab090346c9c5"
          },
          {
            "Value": "value62fa5ab1-b11b-4c3e-b72b-985c3f8173b7",
            "Label": "label8678574b-ba33-42c5-bf0f-899fa808c997"
          },
          {
            "Value": "value761e3eca-cb6a-443a-91b9-4454fd66500e",
            "Label": "labeld4a2e8fb-a613-421a-8c80-ea45747b5f9b"
          }
        ],
        "FormFieldDataType": "FormFieldDataType7e63a250-5a5a-4984-8491-41f625701825"
      },
      {
        "Id": 131,
        "Name": "Name82c9f299-790d-48bb-8d0d-9c24c0da5d29",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Valuee82f02d8-06e6-44c3-8432-5dadec623b7d",
        "Values": [
          "fbf13989-abc5-4049-8093-d0632cb4204e",
          "891efc74-60ae-4130-b0a6-de0f0cc1ef38",
          "7089f363-0252-4ea6-94fc-13af1239f8d4"
        ],
        "FieldLabel": "FieldLabelc72d69f8-063b-4f19-8370-ee0b5bf864c9",
        "ValueOptions": [
          {
            "Value": "valuef81918b9-6f91-4352-8aa2-524c20b86892",
            "Label": "label97ecd6a2-81cf-4bab-bf0b-1232973df01c"
          },
          {
            "Value": "valued6c4aff7-2527-467f-9bff-0e00bab6e683",
            "Label": "label554edd65-7ce7-4fde-8f4e-a679ac755766"
          },
          {
            "Value": "value8cfe6f43-e807-434d-bc9e-971a545fc275",
            "Label": "label4529641c-b78c-493b-81be-76c4f05aff0f"
          }
        ],
        "FormFieldDataType": "FormFieldDataType29f83e36-5695-497c-a417-a314e2fe35a4"
      }
    ],
    "FormFields": [
      {
        "Id": 39,
        "Name": "Namedf5ed8d2-05eb-4fc2-81d5-56dbd0c1c8a5",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabel838157f9-ae7b-4c2c-a308-4df8aa2611e9",
        "FormFieldDataType": "FormFieldDataType86284b65-a4c7-448b-8509-8fb6a9487257"
      },
      {
        "Id": 1,
        "Name": "Name757c9a74-60e5-4478-9317-ff7be22ea534",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabela97ae9c6-642e-445f-8eb0-1444ec5c0436",
        "FormFieldDataType": "FormFieldDataTypec269f3d6-1ca8-4f4c-b7df-a00f629cc3e4"
      },
      {
        "Id": 59,
        "Name": "Name18ce6b5b-f91b-48f6-89ce-7d9a6eacdf05",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabel72d08527-10c2-4881-b4ab-220ebda6afa4",
        "FormFieldDataType": "FormFieldDataTypeb4ec491a-3008-43f9-9803-73f9b0f48dd2"
      }
    ]
  },
  "FormResponseType": "Default | IsMaxAnswer | EventEnrolled | EventDeclined | EventCancelled | EventParticipated | SurveyRegistration | MultiOptin | PublicationOptIn | RecipientPageAccess | RecipientPageEdit",
  "EventRaisedUtcTimeStamp": "2025-06-12T00:03:36.560424"
}

Mail publication opt-out

mail.publication.opt_out

Get notified when an email address opt-out for a publication.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.publication.opt_out
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId8e46ba92-a724-45c2-b0b1-d0f1174774f0",
    "ExternalPersonId": "ExternalPersonId1fd7c19e-f31f-42c4-b537-9361b199ef0e"
  },
  "MailMessageQueue": {
    "Id": 115,
    "FromEmailAddress": "a83b4@bwz.se",
    "FromName": "FromName2deeaef1-60ab-41bf-b6ec-bf5c41a9b494",
    "ReplyToEmailAddress": "75c6a@bwz.se",
    "Subject": "Subject09d8b4a1-9661-4bdd-a6bb-47d8e7dce12e",
    "SendDate": "2023-05-23T12:31:48.7334883"
  },
  "MailMessage": {
    "Id": 22,
    "Name": "Namefc6b5cc7-6bf4-48c3-b227-686ad146003a"
  },
  "Publication": {
    "Id": 224,
    "Name": "Nameec4156f5-1a87-415d-8c86-19ea8da855e8"
  },
  "MailRecipient": {
    "Id": 39,
    "Email": "c486c@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "EventRaisedUtcTimeStamp": "2026-02-12T00:21:53.5161497"
}

Mail total opt-out

mail.total_opt_out

Get notified when an email is added to the total opt-out list.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: mail.total_opt_out
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIddaac6dfc-45f5-4cd9-8001-24141f781794",
    "ExternalPersonId": "ExternalPersonId6fa6157d-d7fc-4ecb-a19b-f2d57159051e"
  },
  "MailRecipient": {
    "Id": 115,
    "Email": "480a4@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "EventRaisedUtcTimeStamp": "2023-07-26T11:40:07.3074717"
}

SMS message delivered to recipient

sms.message.delivered_to_recipient

Get notified when a SMS message is delivered to a recipient.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: sms.message.delivered_to_recipient
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIddf746ef5-34ea-4359-898b-2b71321af3f8",
    "ExternalPersonId": "ExternalPersonIdd342a75d-35b3-48cc-b662-ec6c19c52294"
  },
  "SmsMessage": {
    "Id": 145,
    "Name": "Name355102b7-8bda-4cfb-b369-d0c257e15805"
  },
  "SmsMessageQueue": {
    "Id": 189,
    "FromNumberOrName": "FromNumberOrName4e29426b-3d89-4593-bb8d-c91d3e82c1b7",
    "SendDate": "2025-02-10T23:01:01.2913534"
  },
  "Publication": {
    "Id": 165,
    "Name": "Namefac6cf6f-053b-4d13-a8dc-f0e7d52affb0"
  },
  "SmsRecipient": {
    "Id": 134,
    "MobileNumber": "MobileNumber913a2dee-73c0-43e4-9c0e-ff32c7ef61ee"
  },
  "DestinationMobileNumber": "DestinationMobileNumberad35aa84-47e7-4f26-8a26-f0d18c3178f1",
  "DeliveredDate": "2023-08-04T22:55:41.1785314",
  "EventRaisedUtcTimeStamp": "2024-05-11T11:08:41.3292536"
}

SMS message send finished

sms.message.send_finished

Get notified when a SMS message send operation has finished. Only triggered once regardless of how many recipients the SMS message has.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: sms.message.send_finished
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId6a261dcc-48e2-4cd8-bb8c-bfc46c0bf1a3",
    "ExternalPersonId": "ExternalPersonId81a696c7-8e60-427f-a685-e3791e95a29d"
  },
  "SmsMessage": {
    "Id": 145,
    "Name": "Name800b55be-1a97-4862-b5c6-1ddf4a776d53"
  },
  "SmsMessageQueue": {
    "Id": 189,
    "FromNumberOrName": "FromNumberOrNamea550c52f-7169-4bd3-84f5-4bdcc6fa3ab8",
    "SendDate": "2025-02-10T23:01:01.2913534"
  },
  "Publication": {
    "Id": 165,
    "Name": "Name13b8dc35-d0a9-4a30-8680-63275c49c6b8"
  },
  "EventRaisedUtcTimeStamp": "2023-08-04T22:55:41.1785314"
}

SMS message send started

sms.message.send_started

Get notified when a SMS message send operation has started. Only triggered once regardless of how many recipients the SMS message has.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: sms.message.send_started
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectId3f8939b6-2735-4896-9ac0-4d7574e9a66e",
    "ExternalPersonId": "ExternalPersonIdf581b3a8-4deb-4099-a44b-186a32034934"
  },
  "SmsMessage": {
    "Id": 40,
    "Name": "Nameed641cfa-3b41-4f95-92ed-cb7b79a2bcf0"
  },
  "SmsMessageQueue": {
    "Id": 193,
    "FromNumberOrName": "FromNumberOrNamee5f1261b-fd4c-4da5-b658-d174c09dcbe2",
    "SendDate": "2023-03-10T16:54:15.0314764"
  },
  "Publication": {
    "Id": 158,
    "Name": "Name4ec181cf-fed0-45bc-a228-acb5104e5ff0"
  },
  "EventRaisedUtcTimeStamp": "2022-12-24T16:57:31.9042059"
}

SMS message sent to recipient

sms.message.sent_to_recipient

Get notified when a SMS message is sent to a recipient.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: sms.message.sent_to_recipient
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIdd3c6353f-7c3b-4fa6-8c07-0cab4b0097e4",
    "ExternalPersonId": "ExternalPersonIdd29b524b-b73a-403e-b522-3fc63a0c1cd2"
  },
  "SmsMessage": {
    "Id": 145,
    "Name": "Namedfd0a211-7898-415d-b931-40e374b3ee27"
  },
  "SmsMessageQueue": {
    "Id": 189,
    "FromNumberOrName": "FromNumberOrNamec42955a3-8bc8-4166-ad64-9ffb7c847033",
    "SendDate": "2025-02-10T23:01:01.2913534"
  },
  "Publication": {
    "Id": 165,
    "Name": "Nameaafa091c-65c5-433c-8a6b-71a4d711ddbc"
  },
  "SmsRecipient": {
    "Id": 134,
    "MobileNumber": "MobileNumberfc40e945-9a51-4863-a882-f3770d99fba5"
  },
  "EventRaisedUtcTimeStamp": "2023-08-04T22:55:41.1785314"
}

Survey form response

survey.form_response

Get notified when a survey form response is submitted.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: survey.form_response
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "Survey": {
    "Id": 25,
    "Name": "Name66170ce5-9061-4a7d-9c90-e415a0cc107d",
    "Description": "Descriptiond1d2bcab-2765-4803-a1ae-4d258268987e",
    "RegistrationLink": "https://app.bwz.se/example/a33ca",
    "RegistrationOpen": false
  },
  "BiaIntegrator": {
    "ExternalObjectId": "ExternalObjectIdad76ee06-9aea-4fce-aebe-da165d9eb619",
    "ExternalPersonId": "ExternalPersonId9c347d2f-ae9d-472d-900e-85d9a03b0115"
  },
  "FormContext": "FormContext62f1f2cc-fc2b-4fee-8737-fdac25e66839",
  "ResponseWasUpdated": true,
  "MailRecipient": {
    "Id": 235,
    "Email": "cd4ae@bwz.se",
    "Properties": {
      "customstring_firstname": "Bruce",
      "customstring_lastname": "Wayne",
      "customstring_company": "Wayne Enterprises, Inc.",
      "customnumber_age": 25,
      "customlist_options": "optionA|optionB|optionX"
    }
  },
  "Form": {
    "Id": 242,
    "Name": "Nameedfa4ebd-56e5-442d-8c35-327821e6c808",
    "FormType": "EVENT | SURVEY | RECIPIENTPAGE_ACCESS | RECIPIENTPAGE_EDIT | SUBSCRIPTION",
    "FormResponseId": 172,
    "FormFieldValues": [
      {
        "Id": 142,
        "Name": "Name63812f1b-79d8-42d3-ac63-cbf0f5ee5d0e",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Valued51eca9f-587f-4456-87ef-d72a535ea7ae",
        "Values": [
          "0dd1c522-ce51-4efc-84a1-37e1abc2be48",
          "c2cb03cd-26f3-4677-b96d-5bff1b6131eb",
          "dab669b6-966d-43c6-b057-b894dce6c187"
        ],
        "FieldLabel": "FieldLabel172b861e-bb03-42ca-a00b-3ca8b9655340",
        "ValueOptions": [
          {
            "Value": "valueab6efb95-94a6-4a82-b2e9-f0eaa22e6753",
            "Label": "label808700c3-b45f-433b-a850-bedf159d2368"
          },
          {
            "Value": "value8ef8af36-3487-4ac9-bdbf-b346eacf14c6",
            "Label": "labelf32cdc81-a8b8-4d5b-a517-cb5e9e40be01"
          },
          {
            "Value": "valuee380bc26-d805-428f-ae2c-1b74b1fb3ebc",
            "Label": "labelfa50f288-718a-413e-a1af-aef470b91d78"
          }
        ],
        "FormFieldDataType": "FormFieldDataType184f01b8-2852-4d22-a5a0-c70e4fe49cb3"
      },
      {
        "Id": 241,
        "Name": "Name53e3ded0-e468-4c67-ae8a-959ca57691ca",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Valuea83ead13-b6e3-4494-bec7-7f62a5458199",
        "Values": [
          "8728d9b6-9eff-42c8-8be5-e78b7db66ad2",
          "10216385-c6d1-4001-89e7-e467b3315085",
          "adf5d14c-0e72-42a2-a072-958b23ca1783"
        ],
        "FieldLabel": "FieldLabel5f007f84-31ea-4d1e-8996-4beaa812ff32",
        "ValueOptions": [
          {
            "Value": "value93eb45e4-faab-4154-a4c8-e4e7a9d3a435",
            "Label": "label25fc0b00-cff2-4b2e-8a5c-0a6506d55efa"
          },
          {
            "Value": "value13af4a09-1337-4156-bc89-37c5b16fecce",
            "Label": "labelbfb7f0e0-a015-4461-b621-13a16a786fdc"
          },
          {
            "Value": "valuee7454ec0-f6c4-45f8-ab78-ba514347d012",
            "Label": "label50469207-587f-45c0-8445-3c1732f74d28"
          }
        ],
        "FormFieldDataType": "FormFieldDataType7ff8ec7e-9855-4786-9c29-7e8718d789b6"
      },
      {
        "Id": 252,
        "Name": "Name26a188ad-294e-463c-807b-83d7ea21d72f",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "Value": "Valuea7ca4bc5-9a5e-47f5-834b-f13fc8fbca10",
        "Values": [
          "43c5d484-3772-449c-8eda-b439ccc0fd5e",
          "00121446-c470-4975-835c-d216ceebbc44",
          "0eaf2338-437c-46ef-af9a-d43f06fd07c4"
        ],
        "FieldLabel": "FieldLabel15ea2437-7d0f-4c97-95d3-61ee8a6be288",
        "ValueOptions": [
          {
            "Value": "valuede5e9763-3eb1-4a84-ad97-fcd8a235e565",
            "Label": "label642f5c52-a65e-4e14-8416-ce5182267cd4"
          },
          {
            "Value": "valuee94f91d4-cab1-43d6-9a6c-9ca37038afec",
            "Label": "labelf5de94be-aad2-437b-b267-f88462b44dd1"
          },
          {
            "Value": "valuef9967ba6-346d-43b8-9647-247d653716cc",
            "Label": "labeld3688dca-f466-4100-a8c5-aeef10e5fbea"
          }
        ],
        "FormFieldDataType": "FormFieldDataType2b1c5ea0-5d1b-4b45-a6ba-9e150844b528"
      }
    ],
    "FormFields": [
      {
        "Id": 194,
        "Name": "Name294f4ad5-0ada-4ede-af14-a3df327a7a7d",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabelfcd17afd-39d4-47d3-911c-93b597814d61",
        "FormFieldDataType": "FormFieldDataType66e37c5c-c853-4106-865a-250a3d4cb956"
      },
      {
        "Id": 123,
        "Name": "Name1315872b-2386-424a-89bc-7ca33c80a183",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabelf945247a-4f84-4bcb-8a6b-17e64c02cd95",
        "FormFieldDataType": "FormFieldDataType936988d4-33e9-4896-ac28-ccc69734daec"
      },
      {
        "Id": 50,
        "Name": "Name2874be6c-b2aa-48ff-9d8e-c04008b23269",
        "FormFieldPropertyType": "TEXT | NUMBER | LIST | MOBILE_NUMBER | EMAIL | FIRSTNAME | LASTNAME | CHECKBOXES | UNSPECIFIED",
        "ControlType": "TEXT | TEXTAREA | CHECKBOX | RADIO | SUBMIT | HIDDEN",
        "FieldLabel": "FieldLabel426dd1fb-8ba8-4595-823d-e0a31b9a3bb5",
        "FormFieldDataType": "FormFieldDataType50a51b7e-cba1-42a5-9234-c69c50c58625"
      }
    ]
  },
  "FormResponseType": "Default | IsMaxAnswer | EventEnrolled | EventDeclined | EventCancelled | EventParticipated | SurveyRegistration | MultiOptin | PublicationOptIn | RecipientPageAccess | RecipientPageEdit",
  "EventRaisedUtcTimeStamp": "2025-04-17T01:54:07.0091994"
}

Transaction mail message bounced

transactionmail.bounced

Get notified when a transaction mail message bounced.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: transactionmail.bounced
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "TransactionMail": {
    "Id": 173,
    "Subject": "Subject5f81b376-4c26-40dc-a466-c3d29cdf4da6",
    "FromEmailAddress": "dcff6@bwz.se",
    "FromName": "FromNamefe85e02a-174f-4ecf-a394-5407e5186704",
    "SenderEmailAddress": "214f0@bwz.se",
    "SenderName": "SenderName5eaf0531-1dd9-4db2-9c77-8e8a0cf1d98d",
    "ReplyToEmailAddress": "2f5c5@bwz.se",
    "RecipientEmailAddress": "d632e@bwz.se",
    "SendDate": "2024-12-23T18:48:31.2005461",
    "ExternalId": "ExternalId4b6754d6-2218-4253-92d2-70d5adc0db8f"
  },
  "MailBounce": {
    "BounceType": "HARD_BOUNCE | TRANSIENT | UNSUBSCRIBE | SUBSCRIBE | AUTO_RESPONDER | ADDRESS_CHANGE | DNS_ERROR | SPAM_NOTIFICATION | OPEN_RELAY_TEST | UNKNOWN | SOFT_BOUNCE | VIRUS_NOTIFICATION | CHALLENGE_VERIFICATION",
    "Description": "Description59ff98a0-4553-4ca1-a893-ef84371548f7",
    "BounceDate": "2026-03-14T15:39:15.1301596"
  },
  "EventRaisedUtcTimeStamp": "2026-03-19T22:48:53.2427083"
}

Transaction mail message delivered

transactionmail.delivered

Get notified when a transaction mail message has been delivered to the receiving mail server

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: transactionmail.delivered
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "TransactionMail": {
    "Id": 95,
    "Subject": "Subjectaa4ce806-0c2d-40ec-956c-f50eeb3fa5ed",
    "FromEmailAddress": "b5c38@bwz.se",
    "FromName": "FromName32bed101-5547-4454-b39b-5bf9d60a4284",
    "SenderEmailAddress": "5a26a@bwz.se",
    "SenderName": "SenderName6321d1e1-e49a-4d79-a43c-c517c9312428",
    "ReplyToEmailAddress": "2fa1d@bwz.se",
    "RecipientEmailAddress": "90ecb@bwz.se",
    "SendDate": "2023-10-24T07:06:39.9969479",
    "ExternalId": "ExternalIdd4ba7ca1-2ea1-4da6-8e63-e482b265f937"
  },
  "TransactionMailDelivery": {
    "DeliveryDescription": "DeliveryDescriptionfa2b7bef-3b21-4221-87f0-60113048f37c",
    "DeliveryStatus": "DeliveryStatus3a50abde-c751-4749-99af-ab64cb5e45f0",
    "DeliveryDate": "2023-12-09T00:38:57.7349133"
  },
  "EventRaisedUtcTimeStamp": "2026-04-30T16:30:44.7491441"
}

Transaction mail message link clicked

transactionmail.link_clicked

Get notified when a transaction mail message link was clicked. (Only triggered when transaction mail link clicks is enabled)

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: transactionmail.link_clicked
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "TransactionMail": {
    "Id": 95,
    "Subject": "Subject52a6634a-0eb9-4e6f-b425-9d364de1fc6c",
    "FromEmailAddress": "fe068@bwz.se",
    "FromName": "FromName60148b9f-5b97-4753-a080-a11fec2c6bef",
    "SenderEmailAddress": "baf2e@bwz.se",
    "SenderName": "SenderNameeb6066a4-0291-48e5-ab82-9f34e8052cb7",
    "ReplyToEmailAddress": "5d0cd@bwz.se",
    "RecipientEmailAddress": "a7505@bwz.se",
    "SendDate": "2023-10-24T07:06:39.9969479",
    "ExternalId": "ExternalId724dd588-5900-4eb5-a8c2-dc8884c5899e"
  },
  "LinkClickedDate": "2023-09-30T23:23:24.4849222",
  "LinkUrl": "https://app.bwz.se/example/2a308",
  "LinkValue": 15,
  "LinkId": "007cf875-b090-4d9b-bb46-b0eb6a5e2392",
  "LinkCategoryId": 72,
  "LinkName": "Contact me",
  "LinkCategoryName": "https://app.bwz.se/example/3443d",
  "EventRaisedUtcTimeStamp": "2023-12-09T00:38:57.7349133"
}

Transaction mail message not sent

transactionmail.not_sent

Get notified when a transaction mail message is not sent and the reason for not sending it.

Info about not sent reasons

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: transactionmail.not_sent
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "TransactionMail": {
    "Id": 173,
    "Subject": "Subject67104cfa-e046-4023-ab91-9126ea600546",
    "FromEmailAddress": "e1cd5@bwz.se",
    "FromName": "FromName98c777c1-d616-4f64-866d-452c666f278e",
    "SenderEmailAddress": "14777@bwz.se",
    "SenderName": "SenderName95e1b62b-1afd-48e3-bc29-f9b4d7a56559",
    "ReplyToEmailAddress": "3889b@bwz.se",
    "RecipientEmailAddress": "46166@bwz.se",
    "SendDate": "2024-12-23T18:48:31.2005461",
    "ExternalId": "ExternalIdd7582957-2968-4a48-8b1e-f702b5b00298"
  },
  "ReasonText": "NOT_SENT_DUE_TO_SHARED_BLOCK_LIST | NOT_SENT_DUE_TO_OPTOUT | NOT_SENT_DUE_TO_PREVIOUS_BOUNCE",
  "Reason": 222,
  "EventRaisedUtcTimeStamp": "2024-12-06T11:56:13.7521904"
}

Transaction mail message opened

transactionmail.opened

Get notified when a transaction mail message was opened. (Only triggered when transaction mail openings is enabled)

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: transactionmail.opened
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "TransactionMail": {
    "Id": 95,
    "Subject": "Subjecte00ee26d-cb5c-43be-be8a-7a4399a6d7e6",
    "FromEmailAddress": "153a0@bwz.se",
    "FromName": "FromName4885a3e1-6aa7-4ceb-b106-eb8d4fa45680",
    "SenderEmailAddress": "f49e2@bwz.se",
    "SenderName": "SenderNamee619d296-e06f-44f4-a443-1f3bd591aaa4",
    "ReplyToEmailAddress": "25a0f@bwz.se",
    "RecipientEmailAddress": "04a58@bwz.se",
    "SendDate": "2023-10-24T07:06:39.9969479",
    "ExternalId": "ExternalId63d4134e-824a-4a85-b8a2-5a79b9b7b6bf"
  },
  "OpenedDate": "2023-09-30T23:23:24.4849222",
  "EventRaisedUtcTimeStamp": "2023-12-09T00:38:57.7349133"
}

Transaction mail message sent

transactionmail.sent

Get notified when a transaction mail message is sent.

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: transactionmail.sent
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "TransactionMail": {
    "Id": 173,
    "Subject": "Subject34bd5821-4e3b-4bef-a316-a37a5f05a5bb",
    "FromEmailAddress": "31216@bwz.se",
    "FromName": "FromNamee9aaa9ff-7e06-4bee-83cb-1ef7bfb9f152",
    "SenderEmailAddress": "23bc3@bwz.se",
    "SenderName": "SenderNameedee473e-cc36-4e20-bd6f-fdcbf10a0bfb",
    "ReplyToEmailAddress": "bcd14@bwz.se",
    "RecipientEmailAddress": "b9546@bwz.se",
    "SendDate": "2024-12-23T18:48:31.2005461",
    "ExternalId": "ExternalId1725cb2c-c40f-41e4-aca7-eac9143cf524"
  },
  "TransactionMailContent": "3twP",
  "EventRaisedUtcTimeStamp": "2024-12-06T11:56:13.7521904"
}

Transaction SMS delivery failed

transactionsms.delivery.failed

Get notified when a transaction SMS delivery has failed

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: transactionsms.delivery.failed
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "TransactionSms": {
    "Id": 73,
    "FromNumber": "FromNumberece09a6f-db8a-4046-bade-46e63ad4aff8",
    "DestinationNumber": "DestinationNumberd88625f7-aabb-403c-8f94-3972588b9a5a",
    "Text": "Text08cd3887-dd70-40e7-9706-eb35cc024fa3",
    "MaxParts": 197,
    "ScheduledSendTime": "2023-11-20T11:48:02.8881691",
    "TimeOutSeconds": 138
  },
  "Reason": "Reason2150e8eb-85b2-459b-9e87-86936dff70a4",
  "EventRaisedUtcTimeStamp": "2026-04-16T13:17:12.0027218"
}

Transaction SMS delivery succeded

transactionsms.delivery.succeded

Get notified when a transaction SMS delivery has succeded

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: transactionsms.delivery.succeded
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "TransactionSms": {
    "Id": 73,
    "FromNumber": "FromNumberb5b863a6-0d71-4d2a-8050-9265e1cf85c4",
    "DestinationNumber": "DestinationNumberd4844535-e7ab-42c6-b87b-50312b97eeca",
    "Text": "Textf2ec33f1-d9aa-41fe-abe9-a847821ab824",
    "MaxParts": 197,
    "ScheduledSendTime": "2023-11-20T11:48:02.8881691",
    "TimeOutSeconds": 138
  },
  "EventRaisedUtcTimeStamp": "2026-04-16T13:17:12.0027218"
}

Transaction SMS sent

transactionsms.sent

Get notified when a transaction SMS is sent

Payload

POST https://mysystem.se/webhook

content-type: application/json; charset=utf-8
bizwizard-appid: 4313CF4B-DD0C-4242-8268-E4906DE130E2
bizwizard-topic: transactionsms.sent
bizwizard-id: 0bd587a1-276e-41ed-9719-450d74e61fc2
bizwizard-signature: 4313CF4B-DD0C-4242-8268-E4906DE130E2:xYh71FtVFqftHqUbFWkJ4lHxU6i4maW2IzHvE1KRkzw=:dbccfc46ffd24aed8e540520a189de33:1534756415.97717
accept: application/json

{
  "TransactionSms": {
    "Id": 115,
    "FromNumber": "FromNumber3ef86f74-fa77-4098-bd97-19ebeab096de",
    "DestinationNumber": "DestinationNumberecc0038c-c77c-478f-810b-ea9a302ceec6",
    "Text": "Text4d556527-3ecf-4129-b778-5e719bb9b348",
    "MaxParts": 95,
    "ScheduledSendTime": "2025-06-07T06:46:50.0143758",
    "TimeOutSeconds": 15
  },
  "EventRaisedUtcTimeStamp": "2023-10-24T07:06:39.9969479"
}

Security

In addition to HTTP Secure it is possible to verify the integrity, authenticity, and the identity of the message sender with Hash-based Message Authentication Code. With the signature and a random nonce a UNIX timestamp are sent so the receiving application can detect and reject replay requests.

How to verify the signature

using System;
using System.Linq;
using System.Security.Cryptography;
using System.Text;
using System.Net.Http;

namespace WebHook.Publish.Authentication
{
    public static class Signature
    {
        public static bool Verify(HttpRequestMessage request, string sharedSecret)
        {
            if (!request.Headers.TryGetValues(HttpClientConstants.HeaderSignatureName, out var headerSignature))
            {
                return false;
            }

            var signature = headerSignature.First();
            var signatureValues = signature.Split(':');
            if (signatureValues.Length != 4)
            {
                return false;
            }

            var appId = signatureValues[0];
            var requestSignature = signatureValues[1];
            var randomNounce = signatureValues[2];
            var unixTimestamp = signatureValues[3];
            
            var requestHttpMethod = request.Method.Method;
            var targetUri = request.RequestUri.AbsoluteUri;
            var content = request.Content;

            var generatedSignature = GenerateSignature(
                requestHttpMethod,
                content,
                appId,
                targetUri,
                sharedSecret,
                randomNounce,
                unixTimestamp);

            return requestSignature == generatedSignature;
        }

        public static string GenerateSignature(
            string requestHttpMethod,
            HttpContent content,
            string appId,
            string targetUri,
            string sharedSecret,
            string randomNounce,
            string unixTimestamp)
        {
            var requestContentBase64String = CreateHashedRequestContentBase64String(content);

            var signatureRawData = $"{appId}{requestHttpMethod}{targetUri}" +
                                   $"{unixTimestamp}{randomNounce}{requestContentBase64String}";

            return GetHashHmacsha256(signatureRawData, sharedSecret);
        }

        private static string CreateHashedRequestContentBase64String(HttpContent httpContent)
        {
            var contentByteArray = httpContent.ReadAsByteArrayAsync().Result;
            using (var cryptoProvider = new MD5CryptoServiceProvider())
            {
                var hash = cryptoProvider.ComputeHash(contentByteArray);
                return Convert.ToBase64String(hash);
            }
        }

        private static string GetHashHmacsha256(string value, string key)
        {
            using (var cryptoProvider = new HMACSHA256(Encoding.UTF8.GetBytes(key)))
            {
                var hash = cryptoProvider.ComputeHash(Encoding.UTF8.GetBytes(value));
                return Convert.ToBase64String(hash);
            }
        }
    }
}

HTTP POST Request
Encoding UTF8
Media type application/json
Payload

{
    TestContent = "Test"
}

Nounce 4b831576e8f14d20b1430e264ec41891
Timestamp 1530698255.38669
App-id appid
Target URI https://webhook.site/293981fd-afb1-4db4-ad5a-cf305330b7a3
Shared secret key abc123

will generate a signature like WZ41ZsjgqWbEBgg72GwlydSXozrw7dHhdccYOe6R17s=