Example
Suppose you have subscribed to thebusiness.updated webhook event, you will receive a notification every time a business is updated.
Event Envelope
Every webhook event is delivered with a standard envelope containing the following top-level fields:Idempotency
Events may be delivered more than once (for example, due to network retries). Each event includes a uniqueevent_id that remains stable across redeliveries of the same event. Your integration should track processed event_id values and skip duplicates to ensure idempotent handling.
Webhook vs API
APIs send you the data when you request it. For Webhooks, you do not need to make a request. You receive the data when it is available.Example
If you need to know whether a Applicant has accepted the invitation using APIs, you need to keep polling every few seconds until applicant has accepted the invitation. However, if you are using Webhooks, you can configure a webhook event business.onboarded to receive notifications when a business has accepted an invitation and onboarded.
Webhooks
Applicant Webhooks
Webhook events related to Applicant
Business Webhooks
Webhook events related to Business
Case Webhooks
Webhook events related to Case
Integration Webhooks
Webhook events related to Integrations
Onboarding Webhooks
Webhook events related to Onboarding
Payment Processor Webhooks
Webhook events related to Payment Processor
Risk Webhooks
Webhook events related to risk
Worth Score Webhooks
Webhook events related to Worth Score