Test an endpoint

Overview

Here we will be showing how to test your webhook subscriptions by using the functionality already available in your dashboard.

Webhook shared secret

You can find out your shared secret by clicking the Show shared secret link.

Show shared secret image

Test your endpoint

On the webhook subscriptions section, click the Details button.

Add an endpoint image

Inside the Edit Webhook Subscription modal, click the SEND TEST button at the bottom.

Webhook subscriptions image

Here, select one of the events to be tested and click the TEST button at the bottom.

Webhook subscriptions image

This will trigger an HTTP call to your endpoint and will return the status of the request in the response section, such as below:

Webhook subscriptions image

You can do the same for the other event type:

Webhook subscriptions image

Payload structure

Each successful request will receive a removeBounceId and an eventName.

Here you can find a list of all events we send to you.

Here is an example of the payload for the list:started event. This is the body of the request.

# Webhook subscription response for list:started example

{
  "removeBounceId": "5e9606db8a147f1652e0a45d",
  "eventName": "list:started"
}

Here is an example of the payload for the list:completed event. This is the body of the request.

# Webhook subscription response for list:completed example

{
  "removeBounceId": "5e9606db8a147f1652e0a45d",
  "eventName": "list:completed",
  "emails": [
    {
      "email": "test1@domain.com",
      "status": "valid"
    },
    {
      "email": "test2@domain.com",
      "status": "invalid"
    },
    {
      "email": "test3@domain.com",
      "status": "unknown"
    },
    {
      "email": "test4@domain.com",
      "status": "catch_all"
    }
  ]
}
Last Updated: 4/20/2020, 5:38:04 PM