Event Hook Preview

Event Hook Preview allows admins to preview a new Event Hook before it is enabled to see how it interacts with custom code. Event Hook Preview displays the JSON payload of an Event Hook request and enables admins to troubleshoot how their code responds to an event by editing the JSON payload before delivering it.

When no events are generated for an event type, the Event Hook Preview displays an example event with sample data. Undetermined fields are set to null and can be replaced with custom values for testing.

Configure Event Hook Preview

Configure the Event Hook request and then troubleshoot how your code responds. By default, active Event Hooks are listed first, but you can sort the table by type or name.

Before you begin

  • Only super admins can view and configure Event Hooks.
  • Sample Event Hook Preview requests are generated with actual values from recent events. Preview requests for events that have not been generated contain sample values.
  • The Event Hook JSON payload contains event data.

To configure Event Hook Preview

  1. In the Admin Console, go to Workflow > Event Hooks.
  2. Locate the Event Hook that you want to preview, and then click its Actions menu.
  3. Select Preview.
  4. Complete the following tasks on the Preview tab:
    • In the Configure Event Hook request section, select an event from the Event Type drop-down menu.
    • Select an event from the System Log Event drop-down menu. An example event displays if no events are generated for the selected Event Type.
    • The Preview & Deliver Event Hook displays the JSON payload of the request. Verify that the example JSON payload of the request contains event data.
    • Click Edit to make additional edits to the JSON payload and then click Save.
    • Click Deliver Request.

View and edit the JSON Payload

Event Hook Preview displays the JSON payload of an Event Hook request. When no events are generated for an event type, the Event Hook Preview displays an example event with sample data. Undetermined fields are set to null and can be replaced with custom values for testing.

Admins can troubleshoot how their code responds to an event by editing the JSON payload before delivering the payload.

Event Hooks Preview status

Event Hook Preview displays the status of the Event Hook request as successful or failure.

Related topics

Add an Event Hook

Verify your endpoint