Webhook Subscription Lifecycle
A 4-step recipe with RingCentral. We can help you get access.
Recipe · 4 steps
Webhook Subscription Lifecycle
with RingCentral · Webhook & Event Subscription Management
Create, verify, renew, and delete a RingCentral webhook subscription.
- Create the subscription with WebHook delivery. RingCentral immediately calls the delivery address with a validation request, so the endpoint must already be live before this step runs.
- Read the subscription back to confirm the platform accepted the delivery address and moved the subscription into the "Active" state. A subscription left in "Blacklisted" means RingCentral could not validate the endpoint.
- Renew the subscription to push the expiry out by another full lifetime. This is the call an integration schedules well ahead of `expirationTime` to keep notifications flowing.
- Remove the subscription when the integration is decommissioned so RingCentral stops delivering notifications to a retired endpoint.
What you'll need to have ready
- eventFilters: Event filter URIs to subscribe to, for example "/restapi/v1.0/account/~/extension/~/message-store" or "/restapi/v1.0/account/~/extension/~/presence".
- deliveryAddress: The HTTPS URL RingCentral delivers notifications to. Must be publicly reachable and respond to RingCentral's validation handshake.
- verificationToken: Optional token echoed back in the Verification-Token header so the receiver can authenticate inbound notifications.
- expiresIn: Requested subscription lifetime in seconds. WebHook transport permits up to 315360000 seconds (10 years).
For your developer
Arazzo workflow ringcentral:webhook-subscription-lifecycle, 4 operations: createSubscription → readSubscription → renewSubscription → deleteSubscription. Specs on APIs.io.