Skip to main content
Webhooks let ezyshield notify your application when verification events occur. They are made from two related objects: the subscription you configure and the events ezyshield delivers.

​
Webhook subscription

A webhook subscription tells ezyshield where to send events and which event types to send. Use subscriptions to separate environments and consumers. For example, your staging app and production app should have different subscriptions, URLs, and secrets. The subscription secret is returned when the subscription is created. Store it then; it is used to verify webhook signatures. Key API operations:

​
Webhook event

A webhook event is a delivery record for something that happened in ezyshield, such as a verification becoming successful or failed. Your app should store processed event IDs so retries do not create duplicate side effects. If a subscription reaches 10 consecutive delivery failures, ezyshield disables it. Re-enable the subscription after fixing the endpoint.

​
Verification events

For handler implementation, including signature verification and idempotency, see Receive completion events.