On Subscription Event Added

Webhooks Payload on Subscription Event Added

The webhook event is triggered when a subscriber added a new event to an existing subscription.

The following are the webhook event payload details.

Parameter	Type	Description
eventId Always Present	UUID/GUID	Identifier that represents a unique event.
eventType Always Present	String	Value that represents the type of event that occurred. SubscriptionEventAdded
eventDetails Always Present	Event Details - Subscription Event Added	Details about the event that occurred, see below for more information on what is sent for SubscriptionEventAdded event.

Event Details - Subscription Event Added

The following are the object details of Event Details - Subscription Event Added.

Parameter	Type	Description
actionType Always Present	String	Value that represents the type of unsubscribe event that occurred.
calendarSubscriptionId Always Present	UUID/GUID	Identifier that represents a unique Rokt Calendar subscription.
accountId Always Present	UUID/GUID	Identifier that represents a unique Rokt Calendar account.
accountName Always Present	String	Name of the Rokt Calendar account that the subscription belongs to.
accountCode Always Present	String	A URL safe code that uniquely identifies the account the subscription belongs to.
subscription Always Present	Subscription Basic	The object of subscription basic.
subscriptionEvent Always Present	Subscription Event Details	The object of subscription event details.

{
  "eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",   
  "eventType": "SubscriptionEventAdded",
  "eventDetails": {
    "actionType": "SubscriptionViaCalendarPage",
    "accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
    "accountName": "Your Account",
    "accountCode": "your-account",
    "subscription": {
      "calendarSubscriptionId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
      "calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
      "calendarTitle": "My Sports Calendar",
      "calendarCode": "my-sports-calendar",
      "subscriptionMethod": "Google",
    },
    "subscriptionEvent": {
			"title": "Coheed and Cambria CHON",
			"location": "The Bomb Factory 2713 Canton Street, Dallas, TX 75226",
			"description": "AEG presents Coheed and Cambria CHON live at the The Bomb Factory",
			"timezoneBclId": "Central Standard Time",
			"timezoneIanaId": "America/Chicago",
			"startDateTime": "2020-05-09 20:00:00.000000",
			"startDateTimeUtc": "2020-05-10 01:00:00.000000",
			"endDateTime": "2020-05-09 21:30:00.000000",
			"reminderMinutes": 2880,
			"createdDateTimeUtc": "2020-05-05 00:40:51.787000",
			"lastUpdatedDateTimeUtc": "2020-05-05 00:40:51.787000",
			"eventId": "391756"
		},
  }
 }