Troubleshoot Webhooks

When you perform an action to trigger a webhook and it doesn’t work, you can view the request history to figure out what went wrong.

 

Request History

If you aren’t sure if a webhook triggered properly, you can look at the details of the request. From the list of webhooks, click the View requests link to see a recent history of requests for that webhook and what each request returned.

menu

If you haven’t already done so, enable request history for your webhook. Once enabled, you will now be able to start accessing a history of requests made to your webhook. Click the Load new requests button to refresh the page with new requests, as they go out.

enabled

As new requests to your webhook go out, you will see this list fill up with some details:

  1. HTTP Status: displays the outcome of the request in terms of the HTTP Status Code returned by your webhook server
  2. Sent: indicates when the event which triggered the request occurred
  3. Actions: click to see the payload which was sent in the request
history

 

Webhook Payloads

When you click the VIEW PAYLOAD button for an event, you see a copy of the body of the request that was sent to your webhook server, in the form of JSON-encoded data. Each payload contains some common data points, with the following keys:

  • eventType which corresponds to the category (event type) that triggered the request
  • eventID which is a unique identifier for this particular event
  • timestamp which corresponds to when the event triggered the request – this is also present in the request summary

More details about the data formats used in event payloads are available in the Webhook Formats section.

history