Vision 6

Webhook Methods

Top ↑

Overview

A WebHook is a HTTP callback that is sent via POST to a provided URL. A Webhook delivers data to other applications when an event has occurred, rather than querying for changes a Webhook allows you to wait for a notification of data changes.

Webhook Methods

Supported Events

The following is a current list of the event types and which object(s) they apply to:

Event Object Description
created list, contact The object was created
updated list, contact The object was updated
removed list, contact The object was removed
bulk_updated list A large number of contacts in the list were changed or the list was cleared
subscribed contact The contact was subscribed
unsubscribed contact The contact was unsubscribed
deactivated contact The contact was deactivated
reactivated contact The contact was reactivated

Receiving a Webhook

Webhook events will be sent to your nominated URL with a JSON string request body. This data will be relevant to all completed events. Your URL endpoint will need to handle multiple events. For example:

[
    {
        "list_id": 1791,
        "object": "list",
        "event": "created",
        "timestamp": 1496618829
    },
    {
        "list_id": 1791,
        "contact_id": 142,
        "object": "contact",
        "event": "created",
        "timestamp": 1496618831
    }
]

 

Our Webhook request expects a valid response as a method of confirmation that your endpoint has received the information successfully. A HTTP response code between 400 and 599 will be considered a failure and the Webhook event(s) will be queued for sending again soon. All other response codes will be considered a success.

We will retry a failed webhook up to 5 times before considering your endpoint to be invalid at which point we will remove your Webhook entirely.

See Also