RingCentral Events · Example Payload

Create Data Subscription

Subscribe to event data changes via webhook for an event.

EventsVirtual EventsHybrid EventsWebinarsEvent ManagementRegistrationSessionsNetworking

Create Data Subscription is an example object payload from RingCentral Events, with 4 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

summarydescriptionrequestresponse

Example Payload

{
  "summary": "Create a Data Subscription (Webhook)",
  "description": "Subscribe to event data changes via webhook for an event.",
  "request": {
    "method": "POST",
    "url": "https://api.events.ringcentral.com/v1/events/{eventId}/dataSubscriptions",
    "headers": {
      "Authorization": "Bearer {access_token}",
      "Content-Type": "application/json",
      "Accept": "application/json"
    },
    "parameters": {
      "eventId": "evt_001"
    },
    "body": {
      "webhook_url": "https://myapp.example.com/webhooks/ringcentral-events",
      "events": [
        "registration.created",
        "registration.updated",
        "registration.cancelled",
        "attendee.checked_in"
      ]
    }
  },
  "response": {
    "status": 201,
    "headers": {
      "Content-Type": "application/json"
    },
    "body": {
      "id": "sub_def012",
      "event_id": "evt_001",
      "webhook_url": "https://myapp.example.com/webhooks/ringcentral-events",
      "events": [
        "registration.created",
        "registration.updated",
        "registration.cancelled",
        "attendee.checked_in"
      ],
      "active": true,
      "created_at": "2024-08-20T14:30:00Z"
    }
  }
}