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.

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. Unsubscribe
eventDetails Always Present	Event Details - Unsubscribe	Details about the event that occurred, see below for more information on what is sent for Unsubscribe event.

Event Details - Unsubscribe

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

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	Removed Subscription Object	The object of removed subscription.

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