Webhooks

Webhooks allow your systems to be notified of specific contact activities as they happen.Webhooks must be configured before they can be used.
 

Webhooks are set up in the Options menu under Linked Accounts, Sites, and API. You will need to provide the URL for your endpoint and choose which activities and contact data you want delivered.
 

The following should be taken into consideration when developing an endpoint:

• The activities available as webhooks match those returned from the contacts/activities endpoint in our API.
• Endpoints must be https and be able to handle concurrent requests.
• Endpoints must return a 2XX status code within 10 seconds of receiving the payload, otherwise we will consider it a failed batch delivery.
• Events are delivered in batches. The request payload of each batch will consist of an array of 1 or more events, each with a unique eventID. Use the eventID to detect duplicate events.
• Each request will include a unique batchID in a header named X-EMFL-BATCH-ID. Use the X-EMFL-BATCH-ID header to detect duplicate batches.
• Failed requests will be retried every 10 minutes, up to a maximum of 10 times.
• Event timestamps are in GMT.

Example Batch Delivery

Headers
Content-Type: 'application/json'
X-EMFL-BATCH-ID: 'DDBF5504B960765EB533DD5A3D704A224A54A911'

Body
[
  {
    "eventID": "C3EFB0A99E837652B3F9AA0D2F28E391E8E59182",
    "date": "2019-10-01 05:21:00",
    "contact": {
      "email": "john.doe@example.com",
      "contactID": 123
    },
    "email": {
      "subject": "Monthly Newsletter",
      "title": "Monthly Newsletter",
      "dateSent": "2019-10-01 05:21:00",
      "emailID": 456
    },
    "activity": "EMAIL:SENT"
  },
  {
    "eventID": "4E72744BF5924E060818BF8D2FF969DD98FE80BD",
    "date": "2019-10-01 05:35:00",
    "contact": {
      "email": "john.doe@example.com",
      "contactID": 123
    },
    "email": {
      "subject": "Monthly Newsletter",
      "title": "Monthly Newsletter",
      "dateSent": "2017-10-01 05:21:00",
      "emailID": 456
    },
    "activity": "EMAIL:CLICKED",
    "activityDetails": {
      "link": "http://www.example.com"
    }
  }
]