Webhook Event Simulation

Simulating a Webhook Event lets you preview how your Webhook will behave for a specific Event without waiting for another Event to occur. Simulation uses the same serialization and business logic as actual Webhook Event delivery, making it helpful for testing Webhook configurations and debugging delivery issues.

How simulation works

Webhook Event simulation displays a sample Webhook Event that mimics the real delivery process without sending an actual request to your endpoint. The simulation:

• Generates the payload - Creates the exact payload that would be sent, based on serialization, attribute blocklists, and API versioning.
• Applies business logic - Checks if the Event is enabled for the Webhook and whether the payload would pass any configured filters.
• Returns the outcome - Shows you whether the Webhook Event would deliver or skip, without actually delivering the Webhook Event.

Simulation outcomes

The simulation will return one of three outcomes:

• Webhook would deliver - The Webhook Event is enabled and would successfully deliver to your endpoint.
• Webhook would skip - The Webhook Event is enabled, but would skip due to configured filters not matching the payload.
• Event not enabled for Webhook - The specified Event type is not enabled for this Webhook.

How to simulate

1. Provide an event ID - Provide a valid Event ID (can be found in your dashboard’s events tab) to simulate for your webhook.
2. Click simulate - Click the Simulate button to run the simulation.
3. Review outcome - Check the simulated Webhook Event’s payload, as well as whether it would deliver or skip.

Simulate with unsaved changes

You can preview how configuration changes would affect delivery before saving them. When you edit a Webhook’s settings and run a simulation without saving, the simulation uses your unsaved (draft) values instead of the currently saved configuration. A Simulating with unsaved changes banner indicates that draft values are being applied, as shown below.

This lets you test configuration changes—such as adding a filter or attribute blocklist—and confirm the resulting outcome before committing them to your Webhook.

The following configuration fields are applied when simulating with unsaved changes:

• API version
• API key inflection
• Enabled events
• Payload filters
• Attribute blocklists
• Included and relationship allowlists
• File access token expiration

Other fields—such as the Webhook’s name, URL, custom HTTP headers, and OAuth credentials—do not affect simulation outcomes and are ignored. Draft values are validated using the same rules as saving the Webhook, so an invalid value (for example, a file access token expiration outside the allowed range) returns an error rather than a simulated outcome.