Webhooks

Use Webhooks to send email delivery and User engagement data in real-time to other applications.

Webhooks need to be enabled within account settings and the functionality can be further customised at an Email Profile level.

Data for each of the types of activity below can be sent to separate endpoints. Click on each item below to reveal the specifications of requests and the related data.

Multiple processes make Webhook requests in batches approximately every 15 seconds. Each data packet records one transaction. For example, 400 clicks could be sent in one data packet to the Webhook URL endpoint and that would record 1 Transaction.

Requests made to Webhook URL endpoints expect a HTTP 200 response code and when that doesn't happen, or the requests timeout, the data within that packet will be marked as failed and ignored.

Testing Webhooks

Try Beeceptor to simplify your Webhook testing.

Securing Webhooks

Both HTTPS and HTTP are supported and we recommend that in order to increase security only SSL enabled URLs are used.

Always keep your Webhook URLs private and another approach to take in order to increase security is to include a secret key as part of the URL parameters and then check that on all incoming requests and reject where it does not match.

User Created/Updated

This action cannot be overridden within an Email Profile and will always be triggered for Preference Centre updates.

Data packet is sent in the following structure via HTTP POST in the raw body as JSON approximately every 15 seconds. Optional contacts data fields that are provided will be added to the packet and sent. Empty fields will not be included.

[
    {
        "user_id":"12345",
        "email_address":"some@one.com",
        "reference_code":"", [OPTIONAL]
        "title":"", [OPTIONAL]
        "first_name":"", [OPTIONAL]
        "last_name":"", [OPTIONAL]
        "company_name":"", [OPTIONAL]
        "address_line_1":"", [OPTIONAL]
        "address_line_2":"", [OPTIONAL]
        "address_line_3":"", [OPTIONAL]
        "address_line_4":"", [OPTIONAL]
        "city":"", [OPTIONAL]
        "post_code":"", [OPTIONAL]
        "country":"", [OPTIONAL]
        "telephone":"", [OPTIONAL]
        "mobile":"", [OPTIONAL]
        "gender":"", [OPTIONAL]
        "dob":"", [OPTIONAL]
        "edit_user_tags":"", [OPTIONAL]
        "custom_field_1":"", [OPTIONAL]
        "custom_field_2":"", [OPTIONAL]
        "custom_field_3":"", [OPTIONAL]
        "custom_field_4":"", [OPTIONAL]
        "custom_field_5":"", [OPTIONAL]
        "custom_field_6":"", [OPTIONAL]
        "custom_field_7":"", [OPTIONAL]
        "custom_field_8":"", [OPTIONAL]
        "custom_field_9":"", [OPTIONAL]
        "custom_field_10":"", [OPTIONAL]
        "custom_field_11":"", [OPTIONAL]
        "custom_field_12":"", [OPTIONAL]
        "custom_field_13":"", [OPTIONAL]
        "custom_field_14":"", [OPTIONAL]
        "custom_field_15":"", [OPTIONAL]
        "custom_field_16":"", [OPTIONAL]
        "custom_field_17":"", [OPTIONAL]
        "custom_field_18":"", [OPTIONAL]
        "custom_field_19":"", [OPTIONAL]
        "custom_field_20":"", [OPTIONAL]
        "custom_field_21":"", [OPTIONAL]
        "custom_field_22":"", [OPTIONAL]
        "custom_field_23":"", [OPTIONAL]
        "custom_field_24":"", [OPTIONAL]
        "custom_field_25":"", [OPTIONAL]
        "custom_field_26":"", [OPTIONAL]
        "custom_field_27":"", [OPTIONAL]
        "custom_field_28":"", [OPTIONAL]
        "custom_field_29":"", [OPTIONAL]
        "custom_field_30":"", [OPTIONAL]
    }
]

Double Opt-in

Data packet is sent in the following structure via HTTP POST in the raw body as JSON approximately every 15 seconds.

[

    {
        "user_id": "User ID - Integer",
        "email_address": "User Email Address e.g. some@one.com",
        "reference_code": "User Reference Code - String",
        "email_verification_status": "CONFIRMED or UNCONFIRMED",
        "email_verification_date": "YYYY-MM-DD HH:MM:SS",
        "email_verification_confirmation_date": "YYYY-MM-DD HH:MM:SS",
        "workflow_api_identifier": "Workflow API ID - String",
        "workflow_action_description": "Workflow Action Description - Text",
        "user_agent": "Request User Agent String",
        "ip_address": "Request IP Address",
        "rest_hook_id": "Internal ID - Integer",
        "company_id": "Account ID - Integer",
        "company_api_identifier": "Account API ID - String"
    }

]

Campaign Sent

Data packet is sent in the following structure via HTTP POST in the raw body as JSON approximately every 15 seconds.

[
    {
        "campaign_id": "6789",
        "campaign_name": "My Email",
        "email_profile_id": "123",
        "email_profile_name": "My Profile",
        "campaign_delivery_date": "2017-01-16 10:05:26",
        "campaign_report": "https:\/\/control.example.com\/campaigns\/reports?e=s50-UPQOmHSavZVgSWV_BXoPb0ErVGbDp3BSzxy8hmrSY16EOO5Hn00h1BTGLAAbkTp85Zwg..",
        "lists_used": [
            {
                "list_id": "456",
                "list_api_identifier": "MYLIST1",
                "list_description": "My List",
                "list_type": "ADDITIONS"
            },
            {   
                "list_id": "654",
                "list_api_identifier": "MYSUPPRESSION1"
                "list_description": "My Suppression List",
                "list_type": "SUPPRESSIONS"
            }
        ]
    }
]