This page will provide you with detail about the data that makes up the webhooks payload 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.
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. SubscriptionDetailsUpdated |
eventDetails Always Present | Event Details - Subscription Details Updated | Details about the event that occurred, see below for more information on what is sent for SubscriptionDetailsUpdated event. |
Event Details - Subscription Details Updated
The following are the object details of Event Details - Subscription Details Updated.
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 Details | Value that represents updated subscription details. |
{
"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": "[email protected]",
"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"
}
}
}