Skip to main content

Webhook event payload

Introduction

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:

ParamenterTypeDescription
eventId (always present)UUID/GUIDValue 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 occured. See below for more intormation on what is sent for each event type.

Supported event types

On Subscribe

Webhook event payload on subscribe

The webhook event is triggered when an API call made to Create New Subscription endpoint.

The following are the webhook event payload details:

ParameterTypeDescription
eventId (Always Present)UUID/GUIDValue that represents a unique event.
eventType (Always Present)StringValue that represents the type of event that occurred. Subscribe
eventDetails (Always Present)Event Details - SubscribeDetails about the event that occured. See below for more information on what is sent for Subscribe event.

On Subscribe Payload

{
"eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"eventType": "Subscribe",
"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",
"calendarTags": [
{
"tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
"tagText": "Team G"
}
],
"timeZoneTag": {
"windowsName": "Eastern Standard Time"
},
"createdDateTimeUtc": "2017-03-15 03:48:24.822495",
"emailAddress": "john.smith@gmail.com",
"additionalOptIn": false,
"isMarketingAllowed": true,
"remoteIpAddress": "150.101.114.215",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
"referer": "http://google.com/",
"enteredPostCode": "90210",
"cableProvider": "DIRECTV",
"cableProviderLocation": "New York",
"countryCode": "US",
"geoCountry": "United States",
"deviceName": "Desktop",
"utmSource": "Facebook",
"utmMedium": "Display",
"utmCampaign": "2017",
"utmContent": "Mobile_320x50",
"source": "youraccount.roktcalendar.com"
}
}
}

Event Details - Subscribe

The following are the object details of Event Details - Subscribe.

ParameterTypeDescription
actionType (Always Present)StringValue that represents the type of unsubscribe event that occurred. Supported values: SubscriptionViaOneClickLink, SubscriptionViaSms, SubscriptionViaShowsPage, SubscriptionViaCalendarPage, SubscriptionViaWebApi, SubscriptionWithEventsViaWebApi, SubscriptionViaCalReplyNotificationPage
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar subscription.
accountId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar account.
accountName (Always Present)StringName of the Rokt Calendar account that the subscription belongs to.
accountCode (Always Present )StringA URL safe code that uniquely identifies the account the subscription belongs to.
subscription (Always Present)Subscription DetailsThe object of created subscription details.

On Unsubscribe

Webhook event payload on unsubscribe

The webhook event is triggered when an API call made to Deactivate an Existing Subscription endpoint.

The following are the webhook event payload details:

ParameterTypeDescription
eventId (Always Present)UUID/GUIDIdentifier that represents a unique event.
eventType (Always Present)StringValue that represents the type of event that occurred. Unsubscribe.
eventDetails (Always Present)Event Details - UnsubscribeDetails about the event that occurred, see below for more information on what is sent for Unsubscribe event.

On Unsubscribe Payload

{
"eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"eventType": "Unsubscribe",
"eventDetails": {
"actionType": "SubscriptionViaCalendarPage",
"accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
"accountName": "Your Account",
"accountCode": "your-account",
"subscription": {
"removedDateTimeUtc": "2020-05-06 01:18:49.755190",
"unsubscribeReasonText": "The event has come to an end",
"remoteIpAddress": "54.241.167.141",
"countryCode": "US",
"geoCountry": "United States",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36",
"deviceName": "Desktop",
"calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
"calendarId": "f9ddd95e-676d-ea11-aa56-067315f8d3af",
"calendarTitle": "Your calendar",
"calendarCode": "your-calendar",
"subscriptionMethod": "Google"
}
}
}

Event Details - Unsusbscribe

The following are the object details of Event Details - Unsubscribe.

ParameterTypeDescription
actionType (Always Present)StringValue that represents the type of unsubscribe event that occurred.
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar subscription.
accountId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar account.
accountName (Always Present)StringName of the Rokt Calendar account that the subscription belongs to.
accountCode (Always Present)StringA URL safe code that uniquely identifies the account the subscription belongs to.
subscription (Always Present)Removed Subscription ObjectThe object of removed subscription.

On Subscription Details Updated

Webhooks Payload on Subscription Details Updated

The webhook event is triggered when there is a change made to the subscription preference.

The following are the webhook event payload details:

ParameterTypeDescription
eventId (Always Present)UUID/GUIDIdentifier that represents a unique event.
eventType (Always Present)StringValue that represents the type of event that occurred. SubscriptionDetailsUpdated
eventDetails (Always Present)Event Details - Subscription DetailsUpdated Details about the event that occurred, see below for more information on what is sent for SubscriptionDetailsUpdated event.

On Subscribe Details Updated Payload

{
"eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"eventType": "SubscriptionDetailsUpdate",
"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",
"calendarTags": [
{
"tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
"tagText": "Team G"
}
],
"timeZoneTag": {
"windowsName": "Eastern Standard Time"
},
"createdDateTimeUtc": "2017-03-15 03:48:24.822495",
"emailAddress": "john.smith@gmail.com",
"additionalOptIn": false,
"isMarketingAllowed": true,
"remoteIpAddress": "150.101.114.215",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
"referer": "http://google.com/",
"enteredPostCode": "90210",
"cableProvider": "DIRECTV",
"cableProviderLocation": "New York",
"countryCode": "US",
"geoCountry": "United States",
"deviceName": "Desktop",
"utmSource": "Facebook",
"utmMedium": "Display",
"utmCampaign": "2017",
"utmContent": "Mobile_320x50",
"source": "youraccount.roktcalendar.com"
}
}
}

Event Details - Subscription Details Updated

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

ParameterTypeDescription
actionType (Always Present)StringValue that represents the type of unsubscribe event that occurred.
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar subscription.
accountId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar account.
accountName (Always Present)StringName of the Rokt Calendar account that the subscription belongs to.
accountCode (Always Present)StringA URL safe code that uniquely identifies the account the subscription belongs to.
subscription (Always Present)Subscription DetailsValue that represents updated subscription details.

On Subscription Event Added

Webhooks Payload on Sunscription 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:

ParameterTypeDescription
eventId (Always Present)UUID/GUIDIdentifier that represents a unique event.
eventType (Always Present)StringValue that represents the type of event that occurred. SubscriptionEventAdded
eventDetails (Always Present)Event Details - Subscription Event AddedDetails about the event that occurred, see below for more information on what is sent for SubscriptionEventAdded event.

On Subscribe Event Added Payload

{
"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"
},
}
}

Event Details Subscription Event Added

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

ParameterTypeDescription
actionType (Always Present)StringValue that represents the type of unsubscribe event that occurred.
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar subscription.
accountId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar account.
accountName (Always Present)StringName of the Rokt Calendar account that the subscription belongs to.
accountCode (Always Present)StringA URL safe code that uniquely identifies the account the subscription belongs to.
subscription (Always Present)Subscription BasicThe object of subscription basic.
subscriptionEvent (Always Present)Subscription Event DetailsThe object of subscription event details.

On Subscription Event Removed

Webhooks Payload on Subscription Event Removed

The webhook event is triggered when a subscriber unsubscribes an event from their calendar.

The following are the webhook event payload details:

ParameterTypeDescription
eventId (Always Present)UUID/GUIDIdentifier that represents a unique event.
eventType (Always Present)StringValue that represents the type of event that occurred. SubscriptionEventRemoved
eventDetails (Always Present)Event Details - Subscription Event RemovedDetails about the event that occurred, see below for more information on what is sent for SubscriptionEventRemoved event.

On Subscription Event Removed Payload

{
"eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"eventType": "SubscriptionEventRemoved",
"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": {
"eventId": "391756"
},
}
}

Event Details - Subscription Event Removed

The following are the object details of Event Details - Subscription Event Removed:

ParameterTypeDescription
actionType (Always Present)StringValue that represents the type of subscription event updated that occurred.
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar subscription.
accountId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar account.
accountName (Always Present)StringName of the Rokt Calendar account that the subscription belongs to.
accountCode (Always Present)StringA URL safe code that uniquely identifies the account the subscription belongs to.
subscription (Always Present)Subscription BasicValue that represents a subscription basic object.
subscriptionEvent (Always Present)Subscription Event BasicValue that represents a subscription event basic object.

On Subscription Event Updated

Webhooks Payload on Subscription Event Updated

The webhook event is triggered when an API call made to Update Subscription Event endpoint.

The following are the webhook event payload details:

ParameterTypeDescription
eventId (Always Present)UUID/GUIDIdentifier that represents a unique event.
eventType (Always Present)StringValue that represents the type of event that occurred. SubscriptionEventUpdated
eventDetails (Always Present)Event Details - Subscription Event UpdatedDetails about the event that occurred, see below for more information on what is sent for SubscriptionEventUpdated event.

On Subscribe Event Updated Payload

{
"eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"eventType": "SubscriptionEventUpdated",
"eventDetails": {
"actionType": "SubscriptionViaCalendarPage",
"accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
"accountName": "Your Account",
"accountCode": "your-account",
"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"
},
}
}

Event Details - Subscription Event Updated

The following are the object details of Event Details - Subscription Event Updated:

ParameterTypeDescription
actionType (Always Present)StringValue that represents the type of unsubscribe event that occurred.
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar subscription.
accountId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar account.
accountName (Always Present)StringName of the Rokt Calendar account that the subscription belongs to.
AccountCode (Always Present)StringA URL safe code that uniquely identifies the account the subscription belongs to.
subscriptionEvent (Always Present)Subscription Event DetailsThe object of subscription event details.

On Subscription Event Deleted

Webhooks Payload on Subscription Event Update

The webhook event is triggered when an API call made to Delete Subscription Event endpoint.

The following are the webhook event payload details:

ParameterTypeDescription
eventId (Always Present)UUID/GUIDIdentifier that represents a unique event.
eventType (Always Present)StringValue that represents the type of event that occurred. SubscriptionEventDeleted
eventDetails (Always Present)Event Details - Subscription Event DeletedDetails about the event that occurred, see below for more information on what is sent for SubscriptionEventDeleted event.

On Subscribe Event Update Payload

{
"eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"eventType": "SubscriptionEventRemoved",
"eventDetails": {
"actionType": "SubscriptionViaCalendarPage",
"accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
"accountName": "Your Account",
"accountCode": "your-account",
"subscriptionEvent": {
"eventId": "391756"
},
}
}

Event Details - Subscription Event Deleted

The following are the object details of Event Details - Subscription Event Deleted:

ParameterTypeDescription
actionType (Always Present)StringValue that represents the type of subscription event updated that occurred.
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar subscription.
accountId (Always Present)UUID/GUIDIdentifier that represents a unique Rokt Calendar account.
accountName (Always Present)StringName of the Rokt Calendar account that the subscription belongs to.
accountCode (Always Present)StringA URL safe code that uniquely identifies the account the subscription belongs to.
subscriptionEvent (Always Present)Subscription Event BasicThe object of a basic subscription event .

Shared Objects

Subscription Basic

The subscription object with basic information. Following are the details of the Subscription Basic object.

ParameterTypeDescription
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique user that has subscribed to a calendar.
calendarId (Always Present)UUID/GUIDIdentifier that represents the calendar a subscription was for.
calendarTitle (Always Present)StringThe name of the calendar the user has subscribed to.
calendarCode (Always Present)StringA URL safe code that uniquely identifies the calendar the user has subscribed to.
subscriptionMethod (Sometimes Present)StringValue that represents the type of subscription created. Currently supported values: Webcal, Google and Microsoft

Subscription Basic Object

{
"calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
"calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
"calendarTitle": "My Sports Calendar",
"calendarCode": "my-sports-calendar",
"subscriptionMethod": "Google",
}

Subscription Details

The subscription object with detailed information. Following are the details of the Subscription Details object.

ParameterTypeDescription
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique user that has subscribed to a calendar.
calendarId (Always Present)UUID/GUIDIdentifier that represents the calendar a subscription was for.
calendarTitle (Always Present)StringThe name of the calendar the user has subscribed to.
calendarCode (Always Present)StringA URL safe code that uniquely identifies the calendar the user has subscribed to.
subscriptionMethod (Sometimes Present)StringValue that represents the type of subscription created. Currently supported values: Webcal, Google and Microsoft
calendarTags (Sometimes Present)CalendarTags[]Array of calendar tags to filter events by. Tags are used to group similar events. For example all events that belong to the same sporting team can be tagged with a team name. When a tagId is used, the subscription will only include events tagged with the selected tag.
timeZoneTag (Sometimes Present)TimeZoneTagTime Zone to filter events by, If used, the subscription will include events that are tagged with this time zone and any events that are not tagged with a time zone.
subscriberExternalId (Sometimes Present)StringIdentifier that represents the subscriber for the account, as received from a 3rd party system. E.g. email address, device id, anonymous id.
emailAddress (Sometimes Present)String Email address linked to the subscription. Rokt Calendar allows you to capture the the email address of a subscriber so that you can market to the subscriber at a later date.
additionalOptIn (Optional)BooleanAdditional opt-in allows the subscriber to specify if they are opting-in to the question/statement as defined by the copy associated with the checkbox.
isMarketingAllowed (Sometimes Present)BooleanMarketing opt-in allows the subscriber to specify if they give permission for their email address to be used for marketing purposes.
enteredPostCode (Sometimes Present)StringAn optional field for calendars that utilise channel ID. This is a US Zip Code or Canadian Postal Code.
cableProvider (Sometimes Present)StringThe name of the TV provider as selected by the end-user during the subscription process. This is based on available providers in a specified zip code.
cableProviderLocation (Sometimes Present)StringThe location of the TV provider as selected by the end-user during the subscription process.
remoteIpAddress (Sometimes Present)StringIP Address of the user. Used for monitoring and logging purposes.
userAgent (Always Present)StringUser agent of the user. This is required to determine the if it should be a WebCal or Google subscription. The user agent string extracted from the http header of the API request. This is used to identify the users operating system, device and other important parameters.
referrer (Sometimes Present)StringUrl referrer of the user. Used for Dashboard Analytics. The place from which the subscriber navigated to the calendar page. e.g. Facebook.
countryCode (Sometimes Present)StringThe country code indicating the country from which the subscription was initiated, in format: ISO Alpha-2.
geoCountry (Sometimes Present)StringIndicating the country from which the subscription was initiated.
source (Sometimes Present)StringA consolidated view of the subscription referrer grouped at the domain level.
deviceName (Always Present)StringThe device type from which the subscription was initiated.
utmSource (Sometimes Present)StringValue used to identify the referring subscriber Source. This is used as the UTM Source in Dashboard Analytics. e.g. Newsletter-December.
utmMedium (Sometimes Present)StringValue used to identify the referring subscriber Medium. This is used as the UTM Source in Dashboard Analytics. e.g. Email.
utmCampaign (Sometimes Present)StringValue used to identify the referring subscriber Campaign. in Dashboard Analytics. e.g. Summer Campaign.
utmContent (Sometimes Present)StringValue used to identify the referring subscriber Content. Used for Dashboard Analytics. in Dashboard Analytics. e.g. 400x300 banner.
createdDateTimeUtc (Always Present)DateTimeDate and time in UTC that the subscription was created.
confirmationDateTimeUtc (Always Present)DateTimeDate and time in UTC that the subscription was confirmed.

Subscription Details Object

{
"calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
"calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
"calendarTitle": "My Sports Calendar",
"calendarCode": "my-sports-calendar",
"subscriptionMethod": "Google",
"calendarTags": [
{
"tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
"tagText": "Team G"
}
],
"timeZoneTag": {
"windowsName": "Eastern Standard Time"
},
"createdDateTimeUtc": "2017-03-15 03:48:24.822495",
"emailAddress": "john.smith@gmail.com",
"additionalOptIn": false,
"isMarketingAllowed": true,
"remoteIpAddress": "150.101.114.215",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
"Referer": "http://google.com/",
"enteredPostCode": "90210",
"cableProvider": "DIRECTV",
"cableProviderLocation": "New York",
"countryCode": "US",
"geoCountry": "United States",
"deviceName": "Desktop",
"utmSource": "Facebook",
"utmMedium": "Display",
"utmCampaign": "2017",
"utmContent": "Mobile_320x50",
"source": "youraccount.roktcalendar.com"
}

Subscription Removed

The subscription object with basic and deactivation information. Following are the details of the Subscription Removed object.

ParameterTypeDescription
calendarSubscriptionId (Always Present)UUID/GUIDIdentifier that represents a unique user that has subscribed to a calendar.
calendarId (Always Present)UUID/GUIDIdentifier that represents the calendar a subscription was for.
calendarTitle (Always Present)StringThe name of the calendar the user has subscribed to.
calendarCode (Always Present)StringA URL safe code that uniquely identifies the calendar the user has subscribed to.
subscriptionMethod (Sometimes Present)StringValue that represents the type of subscription created. Currently supported values: Webcal, Google and Microsoft
remoteIpAddress (Sometimes Present)StringIP Address of the user. Used for monitoring and logging purposes.
userAgent (Always Present)StringUser agent of the user. This is required to determine the if it should be a WebCal or Google subscription. The user agent string extracted from the http header of the API request. This is used to identify the users operating system, device and other important parameters.
countryCode (Sometimes Present)StringThe country code indicating the country from which the subscription was initiated, in format: ISO Alpha-2.
geoCountry (Sometimes Present)StringIndicating the country from which the subscription was initiated.
deviceName (Always Present)StringThe device type from which the subscription was initiated.
removedDateTimeUtc (Always Present)DateTimeDate and time in UTC that the subscription was unsubscribed.
unsubscribeReasonText (Sometimes Present)StringText that represents the unsubscribe reason.

Subscription Removed Object

{
"removedDateTimeUtc": "2020-05-06 01:18:49.755190",
"unsubscribeReasonText": "The event has come to an end",
"remoteIpAddress": "54.241.167.141",
"countryCode": "US",
"geoCountry": "United States",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/81.0.4044.129 Safari/537.36",
"deviceName": "Desktop",
"calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
"calendarId": "f9ddd95e-676d-ea11-aa56-067315f8d3af",
"calendarTitle": "domain",
"calendarCode": "domain",
"subscriptionMethod": "Microsoft"
}

Subscription Event Basic

The subscription event object with Id only. Following are the details of the Subscription Event Basic object.

ParameterTypeDescription
eventId (Always Present)StringIdentifier that represents a unique event from an external provider.

Subscription Event Basic Object

{
"eventId": "391756"
}

Subscription Event Details

The subscription event object with details. Following are the details of the Subscription Event Details object.

ParameterTypeDescription
eventId (Always Present)StringIdentifier that represents a unique event from an external provider.
title (Always Present)StringText that represents the title of the event.
description (Always Present)StringText that represents the description of the event.
location (Always Present)StringText that represents the location of the event.
reminderMinutes (Sometimes Present)IntegerNumber that represents the minutes of reminder prompt before the event start time. There will be no reminder prompt if the value is not presented.
timezoneBclId (Always Present)StringValue matches a Windows Time Zones Name.
timezoneIanaId (Always Present)StringValue matches a IANA Time Zones Name.
StartDateTimeUtc (Always Present)DateTimeDate and time in UTC that the event starts.
startDateTime (Always Present)DateTimeDate and time in local timezone that the event starts.
endDateTime (Always Present)DateTimeDate and time in local timezone that the event ends.
createdDateTimeUtc (Always Present)DateTimeDate and time in UTC that the event was created.
lastUpdateDateTimeUtc (Sometimes Present)DateTimeDate and time in UTC that the event was last updated.

Subscription Event Details Object

{
"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"
}

Calendar Tag

The following are the details of the Calendar Tag object.

ParameterTypeDescription
tagId (Always Present)UUID/GUIDIdentifier that represents a unique tag created for the calendar.
tagText (Always Present)StringText that represents the tag. When the tag is created it is given custom text. If the custom text is changed please allow 30 mins for the updated text to reflect in the webhooks payload.

Calendar Tag Object

{
"tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
"tagText": "TeamG"
}

Time Zone Tag

The following are the details of the Time Zone Tag object.

ParameterTypeDescription
windowsName (Always Present)StringValue matches a Windows Time Zones Name.

Time Zone Tag Object

{
"windowsName": "Eastern Standard Time"
}