RingCentral Webhooks and Subscriptions API
The RingCentral Webhooks and Subscriptions API delivers event notifications (telephony, messaging, presence, account, etc.) to subscriber endpoints via webhooks or PubNub channels.
RingCentral Webhooks and Subscriptions API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by an AsyncAPI event-driven specification.
Tagged areas include Webhooks, Events, Subscriptions, and PubNub. The published artifact set on APIs.io includes an API reference, API documentation, and an AsyncAPI specification.
This event API exposes 32 operations across 32 channels, and defines 48 schemas. It is described by AsyncAPI 2.6.0, at version 1.0.0.
The API connects through 2 servers: {webhookUrl} (https), pubsub.pubnub.com (secure-mqtt).
32 operations
32 channels
48 schemas
Metadata
The identity and technical contract details declared by the specification.
Channels & Operations 32
Across 32 channels, the API surfaces 32 operations. Each is listed below with its action, channel, parameters, and response codes.
Channels 32
SUB
/restapi/v1.0/subscription/~
Subscription renewal reminder
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/instant
Inbound SMS Event
SUB
/restapi/v1.0/account/{accountId}/a2p-sms/batches
Message Batch Event
SUB
/restapi/v1.0/account/{accountId}/a2p-sms/batches/{batchId}
Specific Message Batch Event
SUB
/restapi/v1.0/account/{accountId}/a2p-sms/messages
Batch Messages Event
SUB
/restapi/v1.0/account/~/a2p-sms/opt-outs
Batch Message Opt-Out Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/fax
Inbound Fax Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store
Message Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/voicemail
Voicemail Message Event
SUB
/restapi/v1.0/account/{accountId}/phone-number
Contact Center Phone Number Event
SUB
/restapi/v1.0/account/{accountId}/telephony/sessions
Account Telephony Sessions Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/telephony/sessions
Extension Telephony Sessions Event
SUB
/restapi/v1.0/account/{accountId}/presence
Account Presence Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence
Extension Presence Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/dnd
Extension DND Status Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line
Extension Presence Line Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence/line/presence
Extension Presence Line Presence Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite/presence
Favorite Presence Event
SUB
/restapi/v1.0/account/{accountId}/call-queues/{groupId}/presence
Call Queue Member Presence Event
SUB
/team-messaging/v1/posts
Team Messaging Post Event
SUB
/team-messaging/v1/groups
Team Messaging Groups Event
SUB
/team-messaging/v1/chats
Team Messaging Chats Event
SUB
/restapi/v1.0/account/{accountId}/directory/entries
Company Directory Event
SUB
/restapi/v1.0/account/{accountId}/device/{deviceId}/emergency-address
Emergency Address Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/favorite
Extension Favorites Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}/grant
Extension Grant List Event
SUB
/restapi/v1.0/account/{accountId}/extension/{extensionId}
Extension Info Event
SUB
/restapi/v1.0/account/{accountId}/extension
Extension List Event
SUB
/webinar/configuration/v1/company/sessions
Webinar Session Configuration Event
SUB
/webinar/runtime/v1/company/sessions/state
Webinar Session State Event
SUB
/webinar/registration/v1/company/sessions/state
Webinar Registration Session State Event
SUB
/webinar/registration/v1/company/sessions/registrants
Webinar Registrants Event
Messages & Schemas 48
The contract defines 48 schemas that model the data carried by its messages. The most detailed are FaxMessageBody (16 properties), TeamMessagingPostBody (16 properties), VoicemailMessageBody (15 properties), InstantMessageBody (14 properties). Each schema is shown below with its type and property counts.
SubscriptionRenewalReminderEvent
message
Reminder delivered before a subscription's TTL elapses.
InstantMessageEvent
message
MessageEvent
message
VoicemailMessageEvent
message
FaxMessageEvent
message
MessageBatchEvent
message
BatchMessagesEvent
message
BatchMessageOptOutEvent
message
ContactCenterPhoneNumberEvent
message
TelephonySessionsEvent
message
PresenceEvent
message
ExtensionDndStatusEvent
message
TeamMessagingPostEvent
message
TeamMessagingChatEvent
message
CompanyDirectoryEvent
message
EmergencyAddressEvent
message
ExtensionFavoritesEvent
message
ExtensionGrantListEvent
message
ExtensionInfoEvent
message
ExtensionListEvent
message
WebinarEvent
message
EventEnvelope
object
Common envelope wrapping every notification regardless of transport. Field set is documented at https://github.com/ringcentral/ringcentral-api-docs/blob/main/d…
6 properties
3 required
CreateSubscriptionRequest
object
Request body for POST /restapi/v1.0/subscription. Verbatim shape from the RingCentral docs sample code-samples/webhooks/create-webhook-request.json.
3 properties
2 required
DeliveryMode
object
Delivery mode for a subscription. RingCentral documents WebHook and PubNub as the supported transport types on the public Subscriptions API.
8 properties
1 required
SubscriptionResource
object
Subscription resource returned by POST /restapi/v1.0/subscription, GET /restapi/v1.0/subscription/{id}, PUT /restapi/v1.0/subscription/{id}, and POST /restapi/…
8 properties
InstantMessageBody
object
Body of an Inbound SMS event delivered on filter /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store/instant?type=SMS.
14 properties
RecipientInfo
object
5 properties
SenderInfo
object
4 properties
InstantMessageAttachmentInfo
object
5 properties
MessageStoreBody
object
Body of a message-store change event delivered on filter /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store.
4 properties
MessageChange
object
3 properties
VoicemailMessageBody
object
Body of a voicemail event delivered on filter /restapi/v1.0/account/{accountId}/extension/{extensionId}/voicemail.
15 properties
VoicemailAttachmentInfo
object
6 properties
FaxMessageBody
object
Body of an inbound-fax event delivered on filter /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax?direction=Inbound.
16 properties
FaxAttachmentInfo
object
5 properties
TelephonySessionBody
object
Body of a telephony-sessions event delivered on filters /restapi/v1.0/account/{accountId}/telephony/sessions and /restapi/v1.0/account/{accountId}/extension/{e…
7 properties
SessionOriginDetails
object
1 property
SessionPartyDetails
object
13 properties
CalleeInfo
object
4 properties
CallerInfo
object
4 properties
SessionStatusInfo
object
5 properties
SipInfo
object
3 properties
LinkedSessionDetails
object
3 properties
MobilePickupData
object
5 properties
PresenceBody
object
Body of an account/extension presence event delivered on filters such as /restapi/v1.0/account/{accountId}/presence and /restapi/v1.0/account/{accountId}/exten…
10 properties
TeamMessagingPostBody
object
Body of a team messaging post event delivered on filter /team-messaging/v1/posts.
16 properties
MentionInfo
object
3 properties
TeamMessagingChatBody
object
Body of a team messaging chat event delivered on filters /team-messaging/v1/groups and /team-messaging/v1/chats.
10 properties
Specification
The full machine-readable AsyncAPI contract behind this narrative.
Source
More from RingCentral 12
Other APIs RingCentral publishes across the network.
RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Contact Center API
#Webhooks#Events#Subscriptions#PubNub