Données de l'événement de webhook
Introduction
Le niveau racine de la charge utile JSON de l'événement de webhook contient 3 champs: eventId, eventType et eventDetails.
La valeur de [eventDetails] sera renseignée avec un objet spécifique en fonction du type d'événement corrélé.
Voici les détails qui composent l'objet d'événement:
| Paramètre | Type | Description |
|---|---|---|
| eventId (toujours présent) | UUID/GUID | Valeur qui représente un événement unique. |
| eventType (toujours présent) | String | Valeur qui représente le type d'événement qui s'est produit. Les valeurs actuellement prises en charge sont: Subscribe, Unsubscribe, SubscriptionDetailsUpdated, SubscriptionEventAdded, SubscriptionEventUpdated, SubscriptionEventRemoved, SubscriptionEventDeleted, Test |
| eventDetails (toujours présent) | Object | Détails sur l'événement qui s'est produit. Voir ci-dessous pour plus d'informations sur ce qui est envoyé pour chaque type d'événement. |
Types d'événements pris en charge
Sur l'abonnement
Données de l'événement de webhook sur l'abonnement
L'événement de webhook est déclenché lorsqu'un appel API est effectué vers le point de terminaison Create New Subscription.
Voici les détails de la charge utile de l'événement de webhook:
| Paramètre | Type | Description |
|---|---|---|
| eventId (Toujours présent) | UUID/GUID | Valeur qui représente un événement unique. |
| eventType (Toujours présent) | String | Valeur qui représente le type d'événement qui s'est produit. Subscribe |
| eventDetails (Toujours présent) | Détails de l'événement - Subscribe | Détails sur l'événement qui s'est produit. Voir ci-dessous pour plus d'informations sur ce qui est envoyé pour l'événement Subscribe. |
Charge utile sur l'abonnement
{
"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": "États-Unis",
"deviceName": "Desktop",
"utmSource": "Facebook",
"utmMedium": "Display",
"utmCampaign": "2017",
"utmContent": "Mobile_320x50",
"source": "youraccount.roktcalendar.com"
}
}
}
Détails de l'événement - S'abonner
Voici les détails de l'objet de l'événement Détails de l'événement - S'abonner.
| Paramètre | Type | Description |
|---|---|---|
| actionType (Toujours présent) | String | Valeur qui représente le type d'événement de désabonnement qui s'est produit. Valeurs prises en charge : SubscriptionViaOneClickLink, SubscriptionViaSms, SubscriptionViaShowsPage, SubscriptionViaCalendarPage, SubscriptionViaWebApi, SubscriptionWithEventsViaWebApi, SubscriptionViaCalReplyNotificationPage |
| calendarSubscriptionId (Toujours présent) | UUID/GUID | Identifiant qui représente un abonnement unique au calendrier Rokt. |
| accountId (Toujours présent) | UUID/GUID | Identifiant qui représente un compte unique du calendrier Rokt. |
| accountName (Toujours présent) | String | Nom du compte du calendrier Rokt auquel l'abonnement appartient. |
| accountCode (Toujours présent) | String | Un code URL sécurisé qui identifie de manière unique le compte auquel l'abonnement appartient. |
| subscription (Toujours présent) | Détails de l'abonnement | L'objet des détails de l'abonnement créé. |
Sur la désinscription
Données de l'événement du webhook sur la désinscription
L'événement du webhook est déclenché lorsqu'un appel API est effectué pour désactiver une souscription existante.
Voici les détails des données de l'événement du webhook:
| Paramètre | Type | Description |
|---|---|---|
| eventId (Toujours présent) | UUID/GUID | Identifiant qui représente un événement unique. |
| eventType (Toujours présent) | Chaîne de caractères | Valeur qui représente le type d'événement qui s'est produit. Désinscription. |
| eventDetails (Toujours présent) | Détails de l'événement - Désinscription | Détails sur l'événement qui s'est produit, voir ci-dessous pour plus d'informations sur ce qui est envoyé pour l'événement de désinscription. |
Données de l'événement de désinscription
{
"eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"eventType": "Unsubscribe",
"eventDetails": {
"actionType": "SubscriptionViaCalendarPage",
"accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
"accountName": "Votre compte",
"accountCode": "votre-compte",
"subscription": {
"removedDateTimeUtc": "2020-05-06 01:18:49.755190",
"unsubscribeReasonText": "L'événement est arrivé à sa fin",
"remoteIpAddress": "54.241.167.141",
"countryCode": "US",
"geoCountry": "États-Unis",
"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": "Ordinateur de bureau",
"calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
"calendarId": "f9ddd95e-676d-ea11-aa56-067315f8d3af",
"calendarTitle": "Votre calendrier",
"calendarCode": "votre-calendrier",
"subscriptionMethod": "Google"
}
}
}
Détails de l'événement - Désinscription
Voici les détails de l'objet Détails de l'événement - Désinscription.
| Paramètre | Type | Description |
|---|---|---|
| actionType (Toujours présent) | Chaîne de caractères | Valeur qui représente le type d'événement de désinscription qui s'est produit. |
| calendarSubscriptionId (Toujours présent) | UUID/GUID | Identifiant qui représente un abonnement unique au calendrier Rokt. |
| accountId (Toujours présent) | UUID/GUID | Identifiant qui représente un compte unique du calendrier Rokt. |
| accountName (Toujours présent) | Chaîne de caractères | Nom du compte du calendrier Rokt auquel l'abonnement appartient. |
| accountCode (Toujours présent) | Chaîne de caractères | Un code URL sécurisé qui identifie de manière unique le compte auquel l'abonnement appartient. |
| subscription (Toujours présent) | Objet d'abonnement supprimé | L'objet de l'abonnement supprimé. |
Sur les détails de l'abonnement mis à jour
Données de l'événement Webhooks sur les détails de l'abonnement mis à jour
L'événement webhook est déclenché lorsqu'une modification est apportée aux préférences d'abonnement.
Voici les détails de la charge utile de l'événement webhook :
| Paramètre | Type | Description |
|---|---|---|
| eventId (Toujours présent) | UUID/GUID | Identifiant qui représente un événement unique. |
| eventType (Toujours présent) | Chaîne de caractères | Valeur qui représente le type d'événement qui s'est produit. SubscriptionDetailsUpdated |
| eventDetails (Toujours présent) | Détails de l'événement - Détails de l'abonnement | Détails mis à jour sur l'événement qui s'est produit, voir ci-dessous pour plus d'informations sur ce qui est envoyé pour l'événement SubscriptionDetailsUpdated. |
Charge utile de l'événement de mise à jour des détails de l'abonnement
{
"eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"eventType": "SubscriptionDetailsUpdate",
"eventDetails": {
"actionType": "SubscriptionViaCalendarPage",
"accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
"accountName": "Votre compte",
"accountCode": "votre-compte",
"subscription": {
"calendarSubscriptionId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
"calendarTitle": "Mon calendrier sportif",
"calendarCode": "mon-calendrier-sportif",
"subscriptionMethod": "Google",
"calendarTags": [
{
"tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
"tagText": "Équipe 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": "États-Unis",
"deviceName": "Desktop",
"utmSource": "Facebook",
"utmMedium": "Display",
"utmCampaign": "2017",
"utmContent": "Mobile_320x50",
"source": "youraccount.roktcalendar.com"
}
}
}
Détails de l'événement - Détails de l'abonnement mis à jour
Voici les détails de l'objet de l'événement Détails de l'événement - Détails de l'abonnement mis à jour.
| Paramètre | Type | Description |
|---|---|---|
| actionType (Toujours présent) | Chaîne de caractères | Valeur qui représente le type d'événement de désabonnement qui s'est produit. |
| calendarSubscriptionId (Toujours présent) | UUID/GUID | Identifiant qui représente un abonnement unique au calendrier Rokt. |
| accountId (Toujours présent) | UUID/GUID | Identifiant qui représente un compte unique du calendrier Rokt. |
| accountName (Toujours présent) | Chaîne de caractères | Nom du compte du calendrier Rokt auquel l'abonnement appartient. |
| accountCode (Toujours présent) | Chaîne de caractères | Un code URL sécurisé qui identifie de manière unique le compte auquel l'abonnement appartient. |
| subscription (Toujours présent) | Détails de l'abonnement | Valeur qui représente les détails de l'abonnement mis à jour. |
Sur l'événement d'abonnement ajouté
Charge utile des webhooks sur l'événement d'abonnement ajouté
L'événement de webhook est déclenché lorsqu'un abonné ajoute un nouvel événement à un abonnement existant.
Voici les détails de la charge utile de l'événement de webhook:
| Paramètre | Type | Description |
|---|---|---|
| eventId (Toujours présent) | UUID/GUID | Identifiant qui représente un événement unique. |
| eventType (Toujours présent) | Chaîne de caractères | Valeur qui représente le type d'événement qui s'est produit. SubscriptionEventAdded |
| eventDetails (Toujours présent) | Détails de l'événement - Événement d'abonnement ajouté | Détails sur l'événement qui s'est produit, voir ci-dessous pour plus d'informations sur ce qui est envoyé pour l'événement SubscriptionEventAdded. |
Charge utile de l'événement d'abonnement ajouté
{
"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 présente Coheed and Cambria CHON en direct au 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"
},
}
}
Détails de l'événement Abonnement ajouté
Voici les détails de l'objet de l'événement Détails de l'événement Abonnement ajouté :
| Paramètre | Type | Description |
|---|---|---|
| actionType (Toujours présent) | String | Valeur qui représente le type d'événement de désabonnement qui s'est produit. |
| calendarSubscriptionId (Toujours présent) | UUID/GUID | Identifiant qui représente un abonnement unique au calendrier Rokt. |
| accountId (Toujours présent) | UUID/GUID | Identifiant qui représente un compte unique du calendrier Rokt. |
| accountName (Toujours présent) | String | Nom du compte du calendrier Rokt auquel l'abonnement appartient. |
| accountCode (Toujours présent) | String | Un code sécurisé URL qui identifie de manière unique le compte auquel l'abonnement appartient. |
| subscription (Toujours présent) | Abonnement de base | L'objet de l'abonnement de base. |
| subscriptionEvent (Toujours présent) | Détails de l'événement d'abonnement | L'objet des détails de l'événement d'abonnement. |
Sur l'événement de désabonnement
Webhooks Payload on Subscription Event Removed
L'événement de webhook est déclenché lorsque qu'un abonné se désabonne d'un événement de son calendrier.
Voici les détails de la charge utile de l'événement de webhook:
| Paramètre | Type | Description |
|---|---|---|
| eventId (Toujours présent) | UUID/GUID | Identifiant qui représente un événement unique. |
| eventType (Toujours présent) | Chaîne de caractères | Valeur qui représente le type d'événement qui s'est produit. SubscriptionEventRemoved |
| eventDetails (Toujours présent) | Détails de l'événement - Événement de désabonnement | Détails sur l'événement qui s'est produit, voir ci-dessous pour plus d'informations sur ce qui est envoyé pour l'événement SubscriptionEventRemoved. |
Charge utile de l'événement de désabonnement
{
"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"
},
}
}
Détails de l'événement - Événement de désabonnement
Voici les détails de l'objet de l'événement de désabonnement :
| Paramètre | Type | Description |
|---|---|---|
| actionType (Toujours présent) | String | Valeur qui représente le type d'événement de désabonnement mis à jour qui s'est produit. |
| calendarSubscriptionId (Toujours présent) | UUID/GUID | Identifiant qui représente un abonnement unique au calendrier Rokt. |
| accountId (Toujours présent) | UUID/GUID | Identifiant qui représente un compte unique du calendrier Rokt. |
| accountName (Toujours présent) | String | Nom du compte du calendrier Rokt auquel l'abonnement appartient. |
| accountCode (Toujours présent) | String | Un code sûr pour l'URL qui identifie de manière unique le compte auquel l'abonnement appartient. |
| subscription (Toujours présent) | Subscription Basic | Valeur qui représente un objet d'abonnement de base. |
| subscriptionEvent (Toujours présent) | Subscription Event Basic | Valeur qui représente un objet d'événement d'abonnement de base. |
Sur l'événement de mise à jour de l'abonnement
Données du webhook sur l'événement de mise à jour de l'abonnement
L'événement du webhook est déclenché lorsqu'un appel API est effectué vers le point de terminaison de mise à jour de l'événement d'abonnement.
Voici les détails de la charge utile de l'événement du webhook:
| Paramètre | Type | Description |
|---|---|---|
| eventId (Toujours présent) | UUID/GUID | Identifiant qui représente un événement unique. |
| eventType (Toujours présent) | Chaîne de caractères | Valeur qui représente le type d'événement qui s'est produit. SubscriptionEventUpdated |
| eventDetails (Toujours présent) | Détails de l'événement - Événement d'abonnement mis à jour | Détails sur l'événement qui s'est produit, voir ci-dessous pour plus d'informations sur ce qui est envoyé pour l'événement SubscriptionEventUpdated. |
Charge utile de l'événement de mise à jour de l'abonnement
{
"eventId": "0f1d5918-052d-4915-89a7-8cc9c4d33492",
"eventType": "SubscriptionEventUpdated",
"eventDetails": {
"actionType": "SubscriptionViaCalendarPage",
"accountId": "0b98ef2c-f739-45f1-81e3-b2def2bb868f",
"accountName": "Votre compte",
"accountCode": "votre-compte",
"subscriptionEvent": {
"title": "Coheed and Cambria CHON",
"location": "The Bomb Factory 2713 Canton Street, Dallas, TX 75226",
"description": "AEG présente Coheed and Cambria CHON en direct au 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"
},
}
}
Détails de l'événement - Mise à jour de l'événement d'abonnement
Voici les détails de l'objet de l'événement Détails de l'événement - Mise à jour de l'événement d'abonnement :
| Paramètre | Type | Description |
|---|---|---|
| actionType (toujours présent) | String | Valeur qui représente le type d'événement de désabonnement qui s'est produit. |
| calendarSubscriptionId (toujours présent) | UUID/GUID | Identifiant qui représente un abonnement Rokt Calendar unique. |
| accountId (toujours présent) | UUID/GUID | Identifiant qui représente un compte Rokt Calendar unique. |
| accountName (toujours présent) | String | Nom du compte Rokt Calendar auquel l'abonnement appartient. |
| AccountCode (toujours présent) | String | Un code URL sécurisé qui identifie de manière unique le compte auquel l'abonnement appartient. |
| subscriptionEvent (toujours présent) | Détails de l'événement d'abonnement | L'objet des détails de l'événement d'abonnement. |
Sur la suppression de l'événement d'abonnement
Charge utile des webhooks sur la mise à jour de l'événement d'abonnement
L'événement de webhook est déclenché lorsqu'un appel API est effectué pour supprimer l'événement d'abonnement.
Voici les détails de la charge utile de l'événement de webhook :
| Paramètre | Type | Description |
|---|---|---|
| eventId (toujours présent) | UUID/GUID | Identifiant qui représente un événement unique. |
| eventType (toujours présent) | String | Valeur qui représente le type d'événement qui s'est produit. SubscriptionEventDeleted |
| eventDetails (toujours présent) | Détails de l'événement - Événement d'abonnement supprimé | Détails sur l'événement qui s'est produit, voir ci-dessous pour plus d'informations sur ce qui est envoyé pour l'événement SubscriptionEventDeleted. |
Charge utile de la mise à jour de l'événement d'abonnement
{
"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"
},
}
}
Détails de l'événement - Événement de suppression d'abonnement
Voici les détails de l'objet Détails de l'événement - Événement de suppression d'abonnement:
| Paramètre | Type | Description |
|---|---|---|
| actionType (Toujours présent) | String | Valeur qui représente le type d'événement de suppression d'abonnement mis à jour qui s'est produit. |
| calendarSubscriptionId (Toujours présent) | UUID/GUID | Identifiant qui représente un abonnement Rokt Calendar unique. |
| accountId (Toujours présent) | UUID/GUID | Identifiant qui représente un compte Rokt Calendar unique. |
| accountName (Toujours présent) | String | Nom du compte Rokt Calendar auquel l'abonnement appartient. |
| accountCode (Toujours présent) | String | Un code URL sécurisé qui identifie de manière unique le compte auquel l'abonnement appartient. |
| subscriptionEvent (Toujours présent) | Subscription Event Basic | L'objet d'un événement d'abonnement de base. |
Objets partagés
Abonnement de base
L'objet d'abonnement avec des informations de base. Voici les détails de l'objet Abonnement de base.
| Paramètre | Type | Description |
|---|---|---|
| calendarSubscriptionId (Toujours présent) | UUID/GUID | Identifiant qui représente un utilisateur unique qui s'est abonné à un calendrier. |
| calendarId (Toujours présent) | UUID/GUID | Identifiant qui représente le calendrier pour lequel un abonnement a été créé. |
| calendarTitle (Toujours présent) | String | Le nom du calendrier auquel l'utilisateur s'est abonné. |
| calendarCode (Toujours présent) | String | Un code URL sécurisé qui identifie de manière unique le calendrier auquel l'utilisateur s'est abonné. |
| subscriptionMethod (Parfois présent) | String | Valeur qui représente le type d'abonnement créé. Valeurs actuellement prises en charge : Webcal, Google et Microsoft |
Objet de base d'abonnement
{
"calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
"calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
"calendarTitle": "Mon calendrier sportif",
"calendarCode": "mon-calendrier-sportif",
"subscriptionMethod": "Google",
}
Détails de l'abonnement
L'objet d'abonnement avec des informations détaillées. Voici les détails de l'objet Détails de l'abonnement.
| Paramètre | Type | Description |
|---|---|---|
| calendarSubscriptionId (Toujours présent) | UUID/GUID | Identifiant qui représente un utilisateur unique abonné à un calendrier. |
| calendarId (Toujours présent) | UUID/GUID | Identifiant qui représente le calendrier pour lequel un abonnement a été créé. |
| calendarTitle (Toujours présent) | Chaîne de caractères | Le nom du calendrier auquel l'utilisateur est abonné. |
| calendarCode (Toujours présent) | Chaîne de caractères | Un code URL sécurisé qui identifie de manière unique le calendrier auquel l'utilisateur est abonné. |
| subscriptionMethod (Parfois présent) | Chaîne de caractères | Valeur qui représente le type d'abonnement créé. Valeurs actuellement prises en charge : Webcal, Google et Microsoft. |
| calendarTags (Parfois présent) | CalendarTags[] | Tableau de balises de calendrier pour filtrer les événements. Les balises sont utilisées pour regrouper des événements similaires. Par exemple, tous les événements appartenant à la même équipe sportive peuvent être marqués avec le nom de l'équipe. Lorsqu'un identifiant de balise est utilisé, l'abonnement ne comprendra que les événements marqués avec la balise sélectionnée. |
| timeZoneTag (Parfois présent) | TimeZoneTag | Fuseau horaire pour filtrer les événements. Si utilisé, l'abonnement inclura les événements marqués avec ce fuseau horaire et tous les événements qui ne sont pas marqués avec un fuseau horaire. |
| subscriberExternalId (Parfois présent) | Chaîne de caractères | Identifiant qui représente l'abonné pour le compte, tel que reçu d'un système tiers. Par exemple, adresse e-mail, identifiant de périphérique, identifiant anonyme. |
| emailAddress (Parfois présent) | Chaîne de caractères | Adresse e-mail liée à l'abonnement. Rokt Calendar vous permet de capturer l'adresse e-mail d'un abonné afin de pouvoir lui faire de la publicité ultérieurement. |
| additionalOptIn (Optionnel) | Booléen | L'option d'inscription supplémentaire permet à l'abonné de spécifier s'il souhaite s'inscrire à la question/déclaration telle que définie par le texte associé à la case à cocher. |
| isMarketingAllowed (Parfois présent) | Booléen | L'option de consentement marketing permet à l'abonné de spécifier s'il autorise l'utilisation de son adresse e-mail à des fins de marketing. |
| enteredPostCode (Parfois présent) | String | Un champ facultatif pour les calendriers qui utilisent l'ID de canal. Il s'agit d'un code postal américain ou d'un code postal canadien. |
| cableProvider (Parfois présent) | String | Le nom du fournisseur de télévision choisi par l'utilisateur final lors du processus d'abonnement. Cela est basé sur les fournisseurs disponibles dans un code postal spécifié. |
| cableProviderLocation (Parfois présent) | String | L'emplacement du fournisseur de télévision choisi par l'utilisateur final lors du processus d'abonnement. |
| remoteIpAddress (Parfois présent) | String | Adresse IP de l'utilisateur. Utilisée à des fins de surveillance et de journalisation. |
| userAgent (Toujours présent) | String | Agent utilisateur de l'utilisateur. Cela est nécessaire pour déterminer s'il doit s'agir d'un abonnement WebCal ou Google. La chaîne d'agent utilisateur extraite de l'en-tête http de la requête API. Cela est utilisé pour identifier le système d'exploitation, l'appareil et d'autres paramètres importants de l'utilisateur. |
| referrer (Parfois présent) | String | Référent URL de l'utilisateur. Utilisé pour l'analyse du tableau de bord. L'endroit à partir duquel l'abonné a navigué vers la page du calendrier, par exemple Facebook. |
| countryCode (Parfois présent) | String | Le code pays indiquant le pays à partir duquel l'abonnement a été initié, au format : ISO Alpha-2. |
| geoCountry (Parfois présent) | String | Indique le pays à partir duquel l'abonnement a été initié. |
| source (Parfois présent) | String | Une vue consolidée du référent d'abonnement regroupé au niveau du domaine. |
| deviceName (Toujours présent) | String | Le type d'appareil à partir duquel l'abonnement a été initié. |
| utmSource (Parfois présent) | String | Valeur utilisée pour identifier la source d'abonnement de référence. Cela est utilisé comme source UTM dans l'analyse du tableau de bord, par exemple Newsletter-Décembre. |
| utmMedium (Parfois présent) | String | Valeur utilisée pour identifier le support d'abonnement de référence. Cela est utilisé comme source UTM dans l'analyse du tableau de bord, par exemple Email. |
| utmCampaign (Parfois présent) | String | Valeur utilisée pour identifier la campagne d'abonnement de référence dans l'analyse du tableau de bord, par exemple Campagne d'été. |
| utmContent (Parfois présent) | String | Valeur utilisée pour identifier le contenu d'abonnement de référence. Utilisé pour l'analyse du tableau de bord, par exemple bannière 400x300. |
| createdDateTimeUtc (Toujours présent) | DateTime | Date et heure en UTC de la création de l'abonnement. |
| confirmationDateTimeUtc (Toujours présent) | DateTime | Date et heure en UTC de la confirmation de l'abonnement. |
Objet Détails d'Abonnement
{
"calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
"calendarId": "4a2d4acb-bd05-e511-af43-067f1c947754",
"calendarTitle": "Mon Calendrier Sportif",
"calendarCode": "mon-calendrier-sportif",
"subscriptionMethod": "Google",
"calendarTags": [
{
"tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
"tagText": "Équipe G"
}
],
"timeZoneTag": {
"windowsName": "Heure Normale de l'Est"
},
"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": "États-Unis",
"deviceName": "Ordinateur de Bureau",
"utmSource": "Facebook",
"utmMedium": "Affichage",
"utmCampaign": "2017",
"utmContent": "Mobile_320x50",
"source": "youraccount.roktcalendar.com"
}
Abonnement supprimé
L'objet d'abonnement avec des informations de base et de désactivation. Voici les détails de l'objet Abonnement supprimé.
| Paramètre | Type | Description |
|---|---|---|
| calendarSubscriptionId (Toujours présent) | UUID/GUID | Identifiant qui représente un utilisateur unique qui s'est abonné à un calendrier. |
| calendarId (Toujours présent) | UUID/GUID | Identifiant qui représente le calendrier pour lequel une souscription a été effectuée. |
| calendarTitle (Toujours présent) | String | Le nom du calendrier auquel l'utilisateur s'est abonné. |
| calendarCode (Toujours présent) | String | Un code URL sécurisé qui identifie de manière unique le calendrier auquel l'utilisateur s'est abonné. |
| subscriptionMethod (Parfois présent) | String | Valeur qui représente le type d'abonnement créé. Valeurs actuellement prises en charge : Webcal, Google et Microsoft |
| remoteIpAddress (Parfois présent) | String | Adresse IP de l'utilisateur. Utilisée à des fins de surveillance et de journalisation. |
| userAgent (Toujours présent) | String | Agent utilisateur de l'utilisateur. Cela est nécessaire pour déterminer s'il doit s'agir d'un abonnement WebCal ou Google. La chaîne d'agent utilisateur extraite de l'en-tête http de la requête API. Cela est utilisé pour identifier le système d'exploitation, l'appareil et d'autres paramètres importants des utilisateurs. |
| countryCode (Parfois présent) | String | Le code du pays indiquant le pays à partir duquel l'abonnement a été initié, au format : ISO Alpha-2. |
| geoCountry (Parfois présent) | String | Indique le pays à partir duquel l'abonnement a été initié. |
| deviceName (Toujours présent) | String | Le type d'appareil à partir duquel l'abonnement a été initié. |
| removedDateTimeUtc (Toujours présent) | DateTime | Date et heure en UTC auxquelles l'abonnement a été résilié. |
| unsubscribeReasonText (Parfois présent) | String | Texte qui représente la raison de la désinscription. |
Objet de suppression d'abonnement
{
"removedDateTimeUtc": "2020-05-06 01:18:49.755190",
"unsubscribeReasonText": "L'événement est terminé",
"remoteIpAddress": "54.241.167.141",
"countryCode": "US",
"geoCountry": "États-Unis",
"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": "Ordinateur de bureau",
"calendarSubscriptionId": "7ae10174-37fb-4448-8f61-2f86f167009e",
"calendarId": "f9ddd95e-676d-ea11-aa56-067315f8d3af",
"calendarTitle": "domaine",
"calendarCode": "domaine",
"subscriptionMethod": "Microsoft"
}
Événement d'abonnement de base
L'objet d'événement d'abonnement avec uniquement l'ID. Voici les détails de l'objet d'événement d'abonnement de base.
| Paramètre | Type | Description |
|---|---|---|
| eventId (Toujours présent) | String | Identifiant qui représente un événement unique provenant d'un fournisseur externe. |
Objet de base de l'événement d'abonnement
{
"eventId": "391756"
}
Détails de l'événement d'abonnement
L'objet d'événement d'abonnement avec les détails. Voici les détails de l'objet Détails de l'événement d'abonnement.
| Paramètre | Type | Description |
|---|---|---|
| eventId (Toujours présent) | String | Identifiant qui représente un événement unique provenant d'un fournisseur externe. |
| title (Toujours présent) | String | Texte qui représente le titre de l'événement. |
| description (Toujours présent) | String | Texte qui représente la description de l'événement. |
| location (Toujours présent) | String | Texte qui représente l'emplacement de l'événement. |
| reminderMinutes (Parfois présent) | Integer | Nombre qui représente les minutes de rappel avant l'heure de début de l'événement. Il n'y aura pas de rappel si la valeur n'est pas présentée. |
| timezoneBclId (Toujours présent) | String | La valeur correspond à un nom de fuseau horaire Windows. |
| timezoneIanaId (Toujours présent) | String | La valeur correspond à un nom de fuseau horaire IANA. |
| StartDateTimeUtc (Toujours présent) | DateTime | Date et heure en UTC à laquelle l'événement commence. |
| startDateTime (Toujours présent) | DateTime | Date et heure dans le fuseau horaire local à laquelle l'événement commence. |
| endDateTime (Toujours présent) | DateTime | Date et heure dans le fuseau horaire local à laquelle l'événement se termine. |
| createdDateTimeUtc (Toujours présent) | DateTime | Date et heure en UTC à laquelle l'événement a été créé. |
| lastUpdateDateTimeUtc (Parfois présent) | DateTime | Date et heure en UTC à laquelle l'événement a été mis à jour pour la dernière fois. |
Détails de l'événement d'abonnement
{
"title": "Coheed and Cambria CHON",
"location": "The Bomb Factory 2713 Canton Street, Dallas, TX 75226",
"description": "AEG présente Coheed and Cambria CHON en direct au 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"
}
Balise de calendrier
Voici les détails de l'objet Balise de calendrier.
| Paramètre | Type | Description |
|---|---|---|
| tagId (Toujours présent) | UUID/GUID | Identifiant qui représente une balise unique créée pour le calendrier. |
| tagText (Toujours présent) | String | Texte qui représente la balise. Lorsque la balise est créée, elle reçoit un texte personnalisé. Si le texte personnalisé est modifié, veuillez attendre 30 minutes pour que le texte mis à jour soit reflété dans la charge utile des webhooks. |
{
"tagId": "6513319e-d3e1-4497-89ee-b5dcee9a58bc",
"tagText": "TeamG"
}
Tag de Fuseau Horaire
Voici les détails de l'objet Tag de Fuseau Horaire.
| Paramètre | Type | Description |
|---|---|---|
| windowsName (Toujours présent) | String | La valeur correspond au nom d'un fuseau horaire Windows. |
Objet Tag de Fuseau Horaire
{
"windowsName": "Eastern Standard Time"
}