Viewing webhook logs

2022-08-22Last updated

To troubleshoot unreceived webhooks or other associated issues, third-party Application Programming Interface (API) owners can use the webhook logs to verify the status of every HTTP callback request sent to the third-party URL.

Before you begin

Create your webhooks.

What you should know

  • Only an account administrator or third-party API owner can view webhook logs in Genetec ClearID™.
  • The webhook Logs section is only displayed at the end of the webhook details after the first callback has occurred.

Procedure

  1. From the Home page, click Administration > Webhooks .
  2. Select the webhook that you want to troubleshoot.
    Tip: If the Webhooks list is long, you can use the Search field to find the webhook that you require.
  3. In the Logs section Callback date column, click to select a specified range or use the Date range picker to specify your own range.
    Note: The callback data range time period is limited to a maximum of 1 year and the callback information is displayed in reverse chronological order.
    The following image shows callback logs containing Accepted responses.
    Logs section of the Webhook details page in ClearID showing logs for an active webhook including Callback date, URL, and Accepted Response states.
    The following image shows callback logs containing BadRequest responses.
    Logs section of the Webhook details page in ClearID showing logs for an active webhook including Callback date, URL, and BadRequest Response states.
  4. Review the Logs information as follows:
    1. In the Callback date column, check when the callback was sent (includes date range filters).
    2. In the URL column, verify the URL used to forward the webhook event notification that a specified event occurred to the relevant third-party API (program or application).
    3. In the Response column, review the states to verify whether the HTTP callback was received successfully by third-party API or not. For example, Accepted, BadRequest, InternalServerError, and so on.
    4. (Optional) Navigate through the callback logs (forwards or backwards in time) by clicking the Next page or Previous page icons.