This page will help you get started with Rokt Calendar Webhook events payload

Webhook Event Payload

The root level of webhook event JSON payload contains 3 fields: eventId, eventType and eventDetails.

The value of [eventDetails] will be populated with specific object base on the correlated event type.

Following are the details makes up the event object:

ParameterTypeDescription
eventId

Always Present
UUID/GUIDIdentifier that represents a unique event.
eventType

Always Present
StringValue that represents the type of event that occurred.
Currently supported values are:
Subscribe,
Unsubscribe,
SubscriptionDetailsUpdated,
SubscriptionEventAdded,
SubscriptionEventUpdated,
SubscriptionEventRemoved,
SubscriptionEventDeleted,
Test
eventDetails

Always Present
ObjectDetails about the event that occurred, see below for more information on what is sent for each event type.
{
      "eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",   
      "eventType": "Subscribe",
      "eventDetails": {
            ...
      }
 }

Supported Event Types

ROKT Calendar supports webhooks on following event types. Find details of JSON payload on each event type:

  1. Event Payload On Subscribe

  2. Event Payload On Unsubscribe

  3. Event Payload On Subscription Details Updated

  4. Event Payload On Subscription Event Added

  5. Event Payload On Subscription Event Removed

  6. Event Payload On Subscription Event Updated

  7. Event Payload On Subscription Event Deleted