Webhooks

Warning

Our webhook calls have a timeout of 10 seconds, so please ensure you send back a 200 response within that time

We can send notifications about the progress of certain async processes to a URL of your choice. If you would like us to configure a webhook for a particular topic, please contact us.

This is an example structure of our webhooks:

{
    "topic": "end_user.processed",
    "created": "2021-05-20T09:23:53+00:00",
    "data": {
        "heron_id": "eus_Eqio3Y4dhyNiMphrXwG58p",
        "end_user_id": "myenduser",
        "status": "processed"
    },
    "meta": null
}

Where:

  • topic is the event which triggered the webhook
  • createdis the UTC datetime when the webhook was sent, in ISO format
  • data contains the object to which this event refers to
  • meta (optional) contains further information about the event