This page will provide you with detail about the data that makes up the webhooks payload on subscription event removed
Webhooks Payload on Subscription Event Removed
The webhook event is triggered when a subscriber unsubscribes an event from his/her calendar.
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. SubscriptionEventRemoved |
eventDetails Always Present | Event Details - Subscription Event Removed | Details about the event that occurred, see below for more information on what is sent for SubscriptionEventRemoved event. |
Event Details - Subscription Event Removed
The following are the object details of Event Details - Subscription Event Removed.
Parameter | Type | Description |
---|---|---|
actionType Always Present | String | Value that represents the type of subscription event updated 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 | Value that represents a subscription basic object. |
subscriptionEvent Always Present | Subscription Event Basic | Value that represents a subscription event basic object. |
{
"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"
},
}
}