Sep 02, 2022
576
To review the Event Log data follow these steps:
- In the Settings section of Console, select Webhooks.
- Switch from the Webhooks tab to the Event Log tab.
- The Event Log shows the following information for each event that occurred within the past 30 days:
- Event ID
- Trigger Event Type: The type of trigger that triggered this event.
- Type: “Test” (if this was a test event) or “Real” (if this was a user completing a genuine trigger event).
- Time Stamp: The exact time (In UTC) when the event occurred.
- Select an event to view additional information.
- The next page will show this event’s trigger event type, the number of webhooks (i.e. the number of times a webhook has attempted to deliver this information), and type (“test” or “real”).
- The Delivery Log tab shows:
- Delivery ID
- Webhook ID: The ID of the webhook triggered by this event. It’s possible for a single event to trigger multiple different webhooks. For example, if there are multiple webhooks set up to trigger when a user completes a certain Study Task, the event will trigger deliveries associated with each of these webhooks.
- Type: “Test” (if this was a test delivery) or “Real” (if this was a user completing a genuine trigger event).
- Attempt: If a delivery fails, the webhook will automatically attempt to send the delivery again up to 16 times. This column shows which attempt this delivery was.
- Time Stamp: The exact time (In UTC) when the delivery occurred.
- Status: Whether or not the delivery was successful. “200” indicates a successful delivery; all other numbers indicate an unsuccessful attempt.
- Action: This column provides the opportunity to re-attempt the delivery via the “Resend” link.
- The Event Data tab shows the exact data about this event that the webhook sent (or attempted to send) to the destination URL. For definitions of these data points, review BenchPrep’s API documentation.
- The Delivery Log tab shows:
Note: Managing Webhooks is done via Console, check out Who Can Set up Webhooks? to learn more.