Webhook subscription; enables real-time notifications about events that happen in your Yousign organization.
The Webhook resource designates a webhook subscription, which enables real-time notifications about events that happen in your Yousign organisation. Notifications are received on a specified URL, and are triggered on chosen events such as the change in the status of a Signature
Don’t call us, we’ll call you: use Webhooks!
Use Webhooks instead of polling (which involves calling repeatedly the API to retrieve up-to-date data).
We don't allow polling with our API, and we apply rate limiting to prevent you to do so.
Related guide: Webhooks
🔓 Resource access
- Environments:
production - Plans:
plus,pro,scale - Add-ons (for production access): none
Note: unlike other resources, Webhooks are always created in the Production environment, even when they are intended to receive Sandbox events.
Their scope is defined using the sandbox parameter (true for Sandbox, false for Production).