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:- Create a webhook subscription
- List all webhook subscriptions
- Update a webhook subscription
- Delete a webhook subscription
Webhook event
A webhook event is a delivery record for something that happened in ezyshield, such as a verification becomingsuccessful 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
| Event | Use |
|---|---|
verification.pending | Track that a verification is in progress. |
verification.confirmation_ready | Know that the contact confirmation step is ready. |
verification.confirmation_notification_sent | Know that ezyshield sent the contact notification. |
verification.successful | Mark the verification as successful in your system. |
verification.rejected | Handle contact rejection. |
verification.failed | Handle failed verification. |
verification.cancelled | Handle a cancelled or superseded verification. |
verification.expired | Handle an incomplete contact flow. |
verification.error | Investigate an unexpected error. |