Overview
Getting started with MyPreferences 3.0 Version 4 API is easy. Before we dive in, let's spend some time to learn about the supported authorization options and understand how the API library is categorized based on MyPreferences' core framework.
Using API's
Refer to the Authorization section to discover the different authorization methods supported for accessing the MyPreferences API.
The MyPreferences API is a RESTful API that conforms to the constraints of a software architectural style called REST (Representational State Transfer). The API makes the configuration objects and data available as resources represented by unique URLs, also referred as endpoints.
In general, the API supports the following request methods:
GET: To retrieve a resource
POST: To create a new resource
PUT: To update (overwrite) an existing resource
PATCH: To perform partial updates to an existing resource
DELETE: To delete a resource
To access the Swagger specification of the MyPreferences API, click here.
API Categorization
The API's are categorized into three separate sets with distinct functionalities based on the application's core framework: Experiences, Data, and Connectivity.
Data Categorization
In MyPreferences, the data is organized in three main areas: Profiles, Preferences and Consents. The data elements collected in these areas coalesce to form a unified profile, capturing a comprehensive depiction of an individual's identity, preferences, and consents across all channels and interactions across their customer journey.
Profiles
In the Profiles area, you can store various data points including names, contact information, group affiliations, and a wide range of demographic and psychographic details.
Additionally, you have the flexibility to store multiple Alternate IDs, such as system and device identifiers, to uniquely identify individuals and devices within your enterprise ecosystem. This area also encompasses the storage of consents not linked to specific contact elements or preferences, along with Tags, Custom Fields, and Groups for comprehensive organization and categorization of customer data.
Preferences
The Preferences area stores all customer choices, subscriptions, communication frequencies, engagement channels, and any preference attributes. Designed with built-in rules to honor the right preference, propagate preferences, apply expiration, associate consents, and maintain complete preference history to satisfy compliance audits.
Consents
The Consents area serves as a universal consent repository that stores and manages all customer consents. With limitless granularity, you can attach consents to an individual, device or an application. You can also associate consents to a contact element or a preference communication. Designed with built-in rules to honor the right consent, apply expiration settings, auto-notify when a new consent version becomes available, and maintain complete consent history to satisfy compliance audits.
Base URL
Production:
https://pm.mypreferences.com/Profiles/v4
Sandbox:
https://pmstg.mypreferences.com/Profiles/v4
Experience API
The Experience API's, also known as Configuration API's, are a suite of API's purpose-built for retrieving zero-party data configurations to drive highly personalized and relevant customer experiences.
These APIs have built-in localization support and offer specific query parameters to retrieve customized consent, preference, and other zero-party data configurations. This grants you total control over your customers' experiences, covering everything from micro experiences to comprehensive preference centers and everything in between.
These API's are classified as follows:
- Profile Configuration
- Preference Configuration
Endpoints
POST
GET
GET
PATCH
POST
GET
PATCH
POST
GET
PATCH
POST
GET
PATCH
POST
PATCH
GET
POST
GET
PATCH
POST
GET
POST
GET
POST
GET
POST
GET
GET
GET
PATCH
PATCH
PATCH
PATCH
POST
GET
GET
PATCH
POST
POST
GET
PATCH
GET
DELETE
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
GET
Data API
The Data API's facilitate the display and collection of zero-party data for individual profiles across customer touchpoints. When driving customer experiences, they work seamlessly in conjunction with the Experience API to ensure that the relevant elements are accurately displayed on user interfaces, delivering highly personalized customer experiences.
Using the Data API's, you can use any data point on a profile to retrieve the profile. Please note that using contact elements, custom fields, groups, and tags to retrieve a profile may result in multiple matching profiles being returned.
A suite of historical API's are also available as part of this API library. You can retrieve the entire history for any data point associated with a user's profile, including standard fields, contact elements, custom fields, preferences, consents, and more.
Base URL
Production:
https://pm.mypreferences.com/Profiles/v4
Sandbox:
https://pmstg.mypreferences.com/Profiles/v4
Integration API
The Integration API suite includes asynchronous RESTful APIs for bulk import/export operations and Event APIs for retrieving event data, along with webhook subscriptions for real-time updates.
Bulk API
The MyPreferences 3.0 Bulk API is a powerful and efficient asynchronous RESTful API that serves as a robust conduit for seamless data transfer between MyPreferences and various external systems within your enterprise. It ensures that you can effortlessly manage and exchange large datasets, streamlining the process of integrating zero-party data across your technology ecosystem.
One of the primary advantages of the Bulk API lies in its ability to enable near-real time synchronization of customer data. This means that any updates or changes made within MyPreferences or other connected cloud-based or on-premise systems in your enterprise are swiftly propagated and reflected in the interconnected systems. As a result, your organization can maintain a consistent, up-to-date, and comprehensive view of customer data, which is essential for delivering personalized experiences to your customers.
Events API
Event APIs allow you to retrieve event data by account, subscription, profile, or specific event ID based on your webhook subscriptions. They facilitate experiences which enable customers to view their activity history, recent actions, and profile updates in real-time. By retrieving data based on webhook subscriptions, these APIs allow customers to track and review any changes or interactions they have made to their profiles, ensuring they have access to the most up-to-date information about their account activities.
What made this section unhelpful for you?
Base URL
Production:
https://pm.mypreferences.com/Profiles/v4
Sandbox:
https://pmstg.mypreferences.com/Profiles/v4
What made this section unhelpful for you?
Export
The Bulk Export API allows you to retrieve data defined in your data segments to establish near real-time integrations between MyPreferences and other systems, support audience-building use cases, or build an internal service that receives updates at specific intervals.
In addition to retrieving data from segments in full, incremental access is also available by including lastdatetime when initiating the request.
Workflow
Define: Create a segment in MyPreferences that defines the dataset you want to retrieve.
Invoke: Invoke the Initiate endpoint to request the generation of data. You can optionally supply a callback URL to be notified when the data is ready for retrieval.
Status: Check the status of your export by polling the Status endpoint using the access token.
Retrieve: Retrieve the data.
Import
The MyPreferences Import Bulk API allows you to import large sets of zero-party data, including customer profile data, preferences and consents within MyPreferences. It enables you to establish periodical imports to sync MyPreferences with customer data captured in other applications.
Workflow
Initiate: Request to initiate an import
Stage: Stage data that you want to import using the access token. Depending on the size of your request, you may make multiple requests to stage your entire dataset to import
Execute: Once all the data is staged, request to execute the import
Status: Check the status of your import by polling the Status endpoint using the status token
Retrieve (optional): Retrieve any validation failures and exceptions using the Exceptions endpoint.
Events
What are Events?
Events are distinct actions performed within MyPreferences. They serve as triggers to notify external systems about specific activities or changes. Events provide real-time information to keep systems informed and enable integration with other tools and services through webhooks.
An action may be system initiated or user initiated. For instance, it could involve updating the status of a consent or simply switching the IsMobile status on a phone number. These actions also encompass automated tasks executed by the system, such as propagating preferences and consents, as well as recording opt-outs triggered via the Status Manager integration.
An event is synonymous with an Event Type, serving as a clear indicator of the type of action that occurred. Each event type is associated with an Entity.
An Entity represents an object which supports one or more event types. For example, the Preference entity supports the following event types.
preference.addedpreference.updatedpreference.archived
Types of Events
Actions performed on profiles are referred to as Data Events, whereas actions performed exclusively on configuration objects to update, remove or modify configuration settings are referred to as Configuration Events. Currently, MyPreferences only supports data events and offers a wide range of events that cover various interactions and activities within the platform.
The following list highlights all the Data events supported by MyPreferences.
Entity | Event Type |
ProfileActions |
|
Preferences |
|
Consents |
|
Contacts |
|
StandardFields |
|
CustomFields |
|
Groups |
|
Tags |
|
Subscribing to Events
To receive notifications about specific events, MyPreferences clients can subscribe to one or more event types of interest. This involves setting up a webbook subscription, which allows MyPreferences to send event data as an HTTP POST request to an external endpoint that you specify in your subscription request. Click here to access the Create Subscriptions API.
Authentication
Authentication is crucial to ensure the security and integrity of webbook interactions. MyPreferences webhooks support signature validation that allows receiving endpoints to validate webhook's authenticity, i.e., verify that the data is being posted by MyPreferences. Applications receiving event notifications shall provide a secret key which is configurable on all MyPreferences accounts.
All webhook notifications except the initial validation handshake message include a MyPreferences-Webhook header which contains two parameters, Timestamp and Signature.
The Timestamp parameter is part of the header and is also used when generating the signature. Therefore, during signature validation by the receiving system, any modification to the Timestamp field should result in the rejection of the POST request. The Issued Timestamp field is a valid ISO8601 formatted timestamp.
The Signature parameter is generated using a hash-based message authentication code (HMAC) using SHA2 -512. The hash signature is included in the request (authorization) header on each POST request delivered by the webhook.
These parameters are generated and included each time an event is dispatched to a receiving endpoint. In situations where the event is retried due to a failure, a new signature and timestamp is generated for each new attempt.
MyPreferences-Webhook Timestamp:2023-08-16T03:04:54Z Signature:0FIgmwOCx1iZNGqVzCkTZLipCDrVlBhZVKulO80QM0tGocr3axmmZ1x7jwB3doaI6lbagVm0+piN8OMcpxjl8w== The ClientId, EventsClientSignatureUserId, Timestamp, and a Hashkey are used to construct a SHA512 HTMAC hash. This is similar to generating a hash using the custom authorization scheme to access the MyPreferences REST API. Your receiving application consuming the webhooks is expected to extract the timestamp from the header and use the ClientId, EventsClientSignatureUserId, and Hashkey to reconstruct the signature using SHA512. Your re-computed signature (converted to UTF-8 bytes and then to BASE64) must match the Signature included in the header. If it doesn't, the message must be considered as altered and should be rejected.
Initial Handshake
For all webhook subscriptions, the receiving application needs to participate in a validation handshake. Once the subscription is created, MyPreferences will issue a unique token to the receiving URL before any actual data is delivered. The schema of this event is similar to an actual data event and is shown below.
The data portion of this event includes a validationCode property. Your application verifies that the validation request is for an expected event subscription, and returns the validation code in the response synchronously. Once the handshake is established, your endpoint is authenticated, and it can continue receiving webhook notifications without needing to repeat the token exchange. This ensures secure and seamless communication between MyPreferences and your receiving application.
{
"data": {
"validationCode": "056C6FF4-3929-42AC-8E94-C6E021FD1C7B",
"validationUrl": "https://rp-eastus.eventgrid.azure.net:553/eventsubscriptions/53286-1-7f396aa65cda44338b7763091cc02608-221/validate?id=056C6FF4-3929-42AC-8E94-C6E021FD1C7B&t=2024-07-24T14:09:00.9068770Z&apiVersion=2022-06-15&token=mUTqCc6C6t30ij3vEictNyEP%2baZlJ0cqe8RgeqB%2fo74%3d"
},
"dataVersion": "2",
"eventTime": "2024-07-24T14:09:00.9069218Z",
"eventType": "Microsoft.EventGrid.SubscriptionValidationEvent",
"id": "dfd3c295-0a8b-43c8-be7f-bee71f9842e9",
"metadataVersion": "1",
"subject": "",
"topic": "/subscriptions/1ba4431b-6125-4da0-b908-a890a2e39206/resourceGroups/rgroupdnc29/providers/microsoft.eventgrid/domains/eventgriddomainstaging01/topics/53286-1-7f396aa65cda44338b7763091cc02608"
} To prove endpoint ownership, send back the validation code in the validationResponse property as shown below:
{
"validationResponse": "056C6FF4-3929-42AC-8E94-C6E021FD1C7B056C6FF4-3929-42AC-8E94-C6E021FD1C7B"
} You must return an HTTP 200-OK response status code. 202-Accepted isn't recognized as a valid response. The HTTP request must complete within 30 seconds. If the operation doesn't finish within 30 seconds, it will be canceled and can be reattempted after 5 seconds. If all the attempts fail, it will be treated as validation handshake error.
Asynchronous handshake
If you cannot return the validationCode in your response synchronously, a validationUrl property is also included in the data portion of the subscription validation event. To complete the handshake, find that URL in the event data and do a GET request to it. You can use either a REST client or your web browser.
The provided URL is valid for 5 minutes. During that time, the provisioning state of the event subscription is AwaitingManualAction. If you don't complete the manual validation within 5 minutes, the provisioning state is set to Failed. You'll have to create the event subscription again before starting the manual validation.
This method of authentication also requires the webhook endpoint to provide an HTTP status code of 200. This confirms the acceptance of the POST request for the validation event, which is a prerequisite before transitioning into manual validation mode. If the endpoint returns a 200 status code but fails to provide a validation response in a synchronous manner, the system will switch to manual validation mode. Furthermore, if a GET request is made to the validation URL within a 5-minute timeframe, the validation handshake is deemed successful.
Your application's readiness to manage and return the validation code suggests that you've set up the event subscription and are ready to receive events.
Securing Events with mTLS
Events support Mutual Transport Layer Security (mTLS) which brings an extra layer of security between our system and the clients receiving the webhook notifications. With mTLS, both the webhook consumer (receiving systems subscribed to our webhooks) and the webhook producer (our server) engage in mutual authentication, establishing a secure and efficient communication channel. mTLS also ensures data integrity protecting sensitive data from unauthorized access and tampering.
Your receiving endpoint must be setup to handle mTLS, including initiating the validation handshake. mTLS authentication relies on digital certificates, therefore, clients must obtain digital certificates from a trusted Certificate Authority (CA) or an internal PKI (Public Key Infrastructure) before the handshake process.
To enable mTLS support, you must collaborate closely with our support team and follow the steps listed below.
Generate Client Certificate: Obtain a digital certificate for your receiving endpoint from a trusted Certificate Authority (CA). Ensure that the certificate includes the necessary identifying information and is signed by a trusted CA.
Webhook endpoint configuration: Configure your receiving endpoint to present its certificate to the server during the handshake process.
MyPreferences Configuration: The MyPreferences Support team will configure your client certificate on our server for authentication.
Trust Server Certificate: Ensure that your receiving endpoint trusts the certificate provided by MyPreferences.
Test Connection: Test the connection between your receiving endpoint and MyPreferences to ensure that mTLS authentication is setup and functioning correctly.
You will closely collaborate with our support team throughout the setup procedures. Should you encounter any issues during the setup process, reach out to our support team for assistance.
Receiving Events
The system expects a HTTP 200-OK response from the webhook URL. Any other response codes (3xx, 4xx, or 5xx) are treated as a failure. Once the handshake is established, no content is required in the response body from the target webhook URL.
The MaxConcurrentRequests and Durationsettings manage the events throughput. The MaxConcurrentRequests determines how many events the event delivery service will try to send in one cycle. The Duration determines how long it will wait between each cycle. Though we do not track the exact amount of events that are generated via the event handler service, it is a precautionary measure to maintain optimal delivery rate and frequency.
Creating and managing event subscriptions
MyPreferences provides a set of Subscription APIs to manage webhook subscriptions:
- POST /subscriptions: Create a new subscription by specifying the desired event types and the target webhook URL.
- GET /subscriptions: Retrieve a list of active subscriptions along with their details.
- PUT /subscriptions/{subscription_id}: Update the configuration of an existing subscription, such as updating the list of event types.
- DELETE /subscriptions/{subscription_id}: Deactivate and remove a subscription, stopping notifications for selected event types.
Event Payload
When an event occurs, MyPreferences sends an HTTP POST request to the subscribed endpoint. The payload contains information about the event, including its type, timestamp, and relevant data associated with the event.
Subscription Payload
The subscription payload includes details about the subscription itself, such as the ID, webhook URL, and subscribed event types. This information helps identify the source of incoming requests and the event types being monitored.
Failures and retries
MyPreferences expects a 200-OK response to mark the request as success. All configured webhook URLs shall return a 200-OK response immediately upon receiving the event.
The system waits 30 seconds for a response after delivering a message. After 30 seconds, if the endpoint hasn’t responded, the message is queued for retry. It uses an exponential backoff retry policy for event delivery. The retries are performed based on the following schedule on a best effort basis:
If the endpoint responds within three minutes, the message distribution service attempts to remove the event from the retry queue on a best effort basis, but duplicates may still be received. It adds a small randomization to all retry steps and may opportunistically skip certain retries if an endpoint is consistently unhealthy, down for a long period, or appears to be overwhelmed.
The service supports the following retry configurations. An event is dropped if either of the limits of the retry policy is reached.
10 seconds
30 seconds
1 minute
5 minutes
10 minutes
30 minutes
1 hour
3 hours Event time-to-live (TTL): The value must be an integer between 1 and 240. The default value is 240 minutes.
An event is sent to the dead letter queue if it is not delivered within the time-to-live period or the number of retries limit is reached. If we receive a 400 (Bad Request) or 413 (Request Entity Too Large) response code, the event is immediately scheduled for dead-lettering. These response codes indicate delivery of the event will never succeed.
The time-to-live expiration is checked only at the next scheduled delivery attempt. So, even if time-to-live expires before the next scheduled delivery attempt, event expiry is checked only at the time of the next delivery and then subsequently dead-lettered.
Once the event is sent to the dead-letter queue, the event delivery is abandoned. Our event failure notification service picks up the record from the queue, extracts the details, including the appropriate http status returned, failure reason. and sends out email alerts to the list of recipients configured to receive event failure alerts. The alerts are sent based on the alert criteria configuration described below.
Alerts
Alerts are not sent during the retry process. Once the event is sent to the dead-letter queue, the alert notifications are triggered based on the settings detailed below.
Alert Frequency: This represents the rate at which alerts are generated within a specific duration. It indicates how often an alert is triggered based on the occurrence of an event that failed to deliver. It contains the following settings:
- Alert Frequency (Min): This setting defines the minimum time between alerts. It ensures that once an alert is triggered, there is a designated gap before another alert can be generated. This prevents MyPreferences from generating excessive alerts and creating unnecessary noise. Default setting is 5 minutes. It supports values more than 0.
- Alert Frequency (Max): This setting defines the maximum rate at which alerts are triggered when the webhook fails. For example, if the max frequency is set to 5 minutes, the system will not generate more than one alert every 5 minutes. Default setting is 30 minutes.
Alert Threshold: This represents the count/number of errors or failures that must occur within a designated time period to trigger an alert. It ensures that only significant issues are flagged for immediate attention. It works in conjunction with “Alert Frequency” settings. It contains the following settings:
- Alert Threshold (Min): This is the minimum number of errors/failures that must occur within a designated time-frame to trigger an alert. It works in conjunction with “Alert Frequency”. Only values greater than "0" are supported for this setting. The default value is set to "1". Min value cannot exceed "100". For example, if it is is set to 5 consecutive failures, an alert will be generated only if the webhook fails to send notifications for 5 consecutive attempts.
- Alert Threshold (Max): This is the maximum allowable number of errors/failures within a defined duration before generating an alert. It helps prevent excessive alerting for less severe issues. It sets the maximum number of failures that are allowed before the system stops generating alerts. Works in conjunction with “Alert Frequency”. Only values greater than "5" are supported. The default value is set to "15". Max value cannot exceed "1000".
Usage and Recommendations
Utilizing webhooks effectively requires careful consideration of event selection and implementing best practices. One approach is to selectively subscribe to specific event types that align with your needs. For instance, subscribing to profile.created or profile.replaced event types can be advantageous as they provide comprehensive profile information by returning the entire profile. By choosing these events, you can streamline data retrieval while reducing unnecessary traffic.
The profile.replaced event is specifically generated when a PUT operation is performed to overwrite the profile. MyPreferences will not send any other events when profile.created or profile.replaced events are triggered.
When subscribing to Preference events, you can specify the Filters for which you want to receive events. You can specify AllFilters to receive events for all filters.
When subscribing to Consent events, you can specify the Consent Types for which you want to receive events. You can specify AllConsents to receive events for all consent types configured in your MyPreferences account. The same applies to Groups , Contacts, and Custom Fields.
Events for Standard Fields and Tags are applied globally across all profiles. For example, if you subscribe to standardfield.firstname.updated event type, a webhook notification is triggered anytime the first name field gets updated on any active profile.
Multiple actions = Multiple events
Often times, a simple operation on a profile may trigger multiple events. For example, a user adds an email address to their profile, updates a communication preference, and grants a consent. This action will result in the following event types being generated, each indicating the exact operation performed on customer's data.
profile.updatedcontacts.email.addedpreference.addedconsent.filterassociation.created
Each event represents an independent action. You must pay close attention to elements such as OriginalEventTime, EventTime, ProfileId, and associated data to correctly sequence the updates made to a user's profile.
The OriginalEventTime property denotes the date and time when the event
occurred. The EventTime property represents the date and time when the event was queued
for distribution. These dates are designed to help you determine the processing order as well as identify the lag between
the time it took to receive the event from its initial capture.
The Data property includes the updated customer data associated with the event and makes it available for immediate use. The Event property specifies the actual event.
By leveraging MyPreferences Events and Subscriptions framework, clients can stay informed about crucial activities within the platform and seamlessly integrate MyPreferences with external systems to enhance their workflow and decision-making processes.
What made this section unhelpful for you?
Endpoints
POST
PUT
GET
DELETE
PUT
GET
GET
GET
GET
GET
What made this section unhelpful for you?
Event Payload Samples
Welcome to our Webhook Payload Samples section! Here, you'll find a curated collection of sample payloads designed to help you understand the structure and content of the data sent through our webhooks. Whether you're integrating with MyPreferences for the first time or seeking to optimize your existing integrations, these examples serve as valuable references to ensure seamless communication between your applications and MyPreferences.
We have designed a streamlined event structure to efficiently communicate changes to profiles that occur within MyPreferences. Understanding the different types of events and their payloads is essential for effective integration and processing of profile updates. The payload samples are thoughtfully categorized, with each entity having its dedicated page containing events specific to that entity.
What made this section unhelpful for you?
ProfileActions
Profile Created and Replaced: Subscribing to this event type provides you with the entire profile record whenever a new profile is created or an existing profile is replaced with updated information using the Update Profile method . This comprehensive payload contains all the fields associated with the profile as specified in the create or update request.
Profile Deactivated, Reactivated, and Deleted: For these events, you will receive a basic payload containing only the unique identifier (ProfileId or AlternateId) of the profile that has been deactivated or deleted. This minimalist approach ensures that you are informed of the action taken without unnecessary data overhead.
Profile Updated: Whenever any property on a profile is modified, such as last name, email address or a phone number, you will receive the profile.updated event indicating the update. This event will be in addition to any specific event to which you are subscribed. For example, if you subscribe to profile.updated and contacts.email.added events, you will receive two events respectively. Similar to deactivation and deletion events, the payload will consist of the profile ID along with basic event information.
Profile Created: The profile.created event is triggered when a new profile is added.
[
{
"Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e",
"WebhookProxyRandomValue": "Y1HTRLXHsw17V8X2Bk93CadK/jNWkdBWnMpJy2JT",
"WebhookProxyHashSignature": "RAiHKo7VrXIYXFLeF0Y/+TS7UWl+5T/rP1qNUZ6HRfis8/zzfZIDGpGogcibMV7BculPX8N5S3hVfUXQsNQ9xQ==",
"WebhookSignature": "Timestamp:2024-03-25T22:58:13Z Signature:6d9yhI6D2eBX/iW5hM91UclHRuzlQGuc9JTVeIAWXjPqzfTOj5VYEo/qrj8+JBtnMOB/Xj/BEF+fft8m2B4kPg==",
"EventId": 162943000,
"EventType": "profile.created",
"Subject": "profile.created",
"Entity": "Profile",
"SubscriptionId": 41,
"Name": "profile.created",
"Description": "profile.created Description",
"ProfileId": 726175,
"Data": {
"Consents": [
{
"ConsentType": "Data Processing Consent",
"ConsentVersion": "version1.0",
"Locale": "en_US",
"ConsentStatus": 1,
"ConsentDate": "2021-06-20T04:00:00.000Z",
"Expired": false,
"SourceId": "Default",
"Edited": {
"CreateDate": "2024-03-25T22:58:12.703Z",
"CreatedBy": "My Accounts Page"
},
"UpdatedVersionPending": false,
"IsActive": true
}
],
"CustomFields": [
{
"Name": "Occupation",
"Value": "Designer",
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-25T22:58:12.703Z",
"CreatedBy": "My Accounts Page"
}
}
],
"Groups": [
{
"GroupType": "Employee",
"IsPrimary": false,
"GroupName": "Marketing",
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-25T22:58:12.703Z",
"CreatedBy": "My Accounts Page"
}
},
{
"GroupType": "Employee",
"IsPrimary": false,
"GroupName": "Product",
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-25T22:58:12.703Z",
"CreatedBy": "My Accounts Page"
}
}
],
"Emails": [
{
"EmailAddressType": "Home",
"EmailAddress": "johnnydoe@example.com",
"IsDefault": false,
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-25T22:58:12.703Z",
"CreatedBy": "My Accounts Page"
}
},
{
"EmailAddressType": "Work",
"EmailAddress": "brian@example.com",
"IsDefault": true,
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-25T22:58:12.703Z",
"CreatedBy": "My Accounts Page"
}
}
],
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-25T22:58:12.703Z",
"CreatedBy": "My Accounts Page"
},
"RegistrationConfirmed": true,
"CustomerType": "Subscriber",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "Brian",
"MiddleName": "f",
"LastName": "Johnson"
},
"DefaultLocale": "es",
"UpdateStatus": "Complete"
},
"AppVersion": 1,
"OriginalEventTime": "2024-03-25T23:29:53.693Z",
"EventTime": "2024-03-25T22:58:12.720Z",
"CreateDate": "2024-03-25T22:58:12.703Z",
"CreatedBy": "My Accounts Page"
}
] Profile Replaced: The profile.replaced event is only generated when a PUT operation is performed on a profile.
[
{
"Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e",
"WebhookProxyRandomValue": "w7PZEk+kQE8+UjucYnaiAWXR7+jg4a8/CFLM",
"WebhookProxyHashSignature": "FNrSQtpf+0EK21C6TuBz0B1Zbw1n5mQwYSAOVgDJ5lEz8bfJEScZoWtV2eFwVf31KbGlSZ1x3tBHZ0pUspJLw==",
"WebhookSignature": "Timestamp:2024-04-02T16:07:47Z Signature:r7uEzl0dQIvSfbNwlYI7Y9xdB3dwayem2Xc0FHAWcrWL+Hof1SFLmRcUFJmhwWZlukcu4e2ZIV3bnU48lJ6AA==",
"EventId": 177457000,
"EventType": "profile.replaced",
"Subject": "profile.replaced",
"Entity": "Profile",
"SubscriptionId": 41,
"Name": "profile.replaced",
"Description": "",
"ProfileId": 18807,
"Data": {
"Consents": [
{
"ConsentType": "ExpressConsent",
"ConsentVersion": "version1.0",
"Locale": "en_US",
"ConsentStatus": 3,
"ConsentDate": "2024-04-01T20:27:10.000Z",
"Expired": false,
"SourceId": "Default",
"Edited": {
"CreateDate": "2021-08-25T17:36:13.167Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
},
"UpdatedVersionPending": false,
"IsActive": true
}
],
"CustomFields": [
{
"Name": "Occupation",
"Value": "Marketing and Creative Manager",
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-21T22:34:24.200Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
}
},
{
"Name": "Interests",
"Value": "Online Gaming::Camping and Outdoors",
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-21T22:43:04.043Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
}
}
],
"Groups": [
{
"GroupType": "Employee",
"IsPrimary": false,
"GroupName": "Marketing",
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-26T21:13:17.203Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
}
}
],
"ProfileTags": [
{
"Name": "frequent visitor"
},
{
"Name": "rewards member"
}
],
"Emails": [
{
"EmailPreferences": [
{
"ProgramId": "Product Offers and Promotions",
"ChannelId": "Email",
"MatchType": "Expressed",
"ReasonCode": "",
"PreferenceStatus": "Active",
"LastModifiedDate": "2024-04-02T16:07:46.660Z",
"UserId": "My Accounts Page",
"SourceId": "Default",
"FilterId": "EM_Product Offers and Promotions",
"PreferenceType": 2,
"FrequencyId": "Default",
"CustomerDate": "2024-04-02T15:21:38.000Z"
}
],
"EmailAddressType": "Home",
"EmailAddress": "john.doe@example.com",
"IsDefault": false,
"Consents": [
{
"ConsentType": "EmailConsent",
"ConsentVersion": "version1",
"Locale": "en",
"ConsentStatus": 1,
"ConsentDate": "2024-04-02T16:00:11.000Z",
"Expired": false,
"SourceId": "Default",
"Edited": {
"CreateDate": "2024-04-02T16:00:16.173Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
},
"UpdatedVersionPending": false,
"IsActive": true
}
],
"IsActive": true,
"Edited": {
"CreateDate": "2021-08-25T17:36:13.167Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
}
},
{
"EmailAddressType": "Alternate",
"EmailAddress": "johnny2@gmail.com",
"IsDefault": false,
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-25T21:52:28.130Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
}
}
],
"PhoneNumbers": [
{
"PhoneType": "Home",
"PhoneNumber": "7702551020",
"PhoneNumberNumeric": 7702551020,
"IsDefault": false,
"IsMobile": false,
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-18T14:44:29.013Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
}
},
{
"PhoneType": "Work",
"PhoneNumber": "4049092300",
"PhoneNumberNumeric": 4049092300,
"IsDefault": false,
"IsMobile": true,
"IsActive": true,
"Edited": {
"CreateDate": "2024-03-25T21:57:08.480Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
}
}
],
"IsActive": true,
"Edited": {
"CreateDate": "2021-08-25T17:36:13.167Z",
"CreatedBy": "My Accounts Page",
"ModifiedDate": "2024-04-02T16:07:46.660Z",
"ModifiedBy": "My Accounts Page"
},
"RegistrationConfirmed": true,
"CustomerType": "Subscriber",
"PreserveConsents": false,
"PreservePreferences": true,
"CustomerName": {
"FirstName": "John",
"MiddleName": "Ronaldinho",
"LastName": "Doe",
"Prefix": "Mr."
},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete",
"ReasonCode": ""
},
"AppVersion": 1,
"OriginalEventTime": "2024-03-25T23:29:53.693Z",
"EventTime": "2024-04-02T16:07:46.700Z",
"CreateDate": "2024-04-02T16:07:46.660Z",
"CreatedBy": "My Accounts Page"
}
] Profile Deactivated: The profile.deactivated event is triggered when an existing profile is deactivated.
[
{
"Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e",
"WebhookProxyRandomValue": "gDQSrcVCq5VP0hlaDKAPjyl7lIlA4PEipSt+BItAyPylz/QI/X8D",
"WebhookProxyHashSignature": "BcNeRujPfWoePmnxThR9d7IBhou6qY09iWx9JYyYH+stjpoSun9AWRmJB13/JkeCW4ztiplqHstnhOk9gRbz8g==",
"WebhookSignature": "Timestamp:2024-03-25T23:15:34Z Signature:LDoIB2WZc/GeMlokaNFwZwHcGIFXvEDwtIAAXb0WLy9Jsw3WG/VUypwFhTW8h2HfTgUTue0kworrfTh2N3Traw==",
"EventId": 163012000,
"EventType": "profile.deactivated",
"Subject": "profile.deactivated",
"Entity": "Profile",
"SubscriptionId": 41,
"Name": "profile.deactivated",
"Description": "profile.deactivated Description",
"ProfileId": 726175,
"Data": {
"ReasonCode": "Past customer",
"ProfileDeactivated": true
},
"AppVersion": 1,
"OriginalEventTime": "2024-03-25T23:29:53.693Z",
"EventTime": "2024-03-25T23:15:33.937Z",
"CreateDate": "2024-03-25T23:15:33.923Z",
"CreatedBy": "My Accounts Page"
}
] Profile Reactivated: The profile.reactivated event is triggered when a deactivated profile is reactivated.
[
{
"Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e",
"WebhookProxyRandomValue": "dLJbZ20ltp8wCAJhmjJyZvk3uqXVMDp44dxkR8VBBME=",
"WebhookProxyHashSignature": "jIeEn36AmHXgn08grjxwyCAt+vBkcv3/Zk2PGOvewCFNaWQRgt0wfFrSikzbm7K2rxBvv0wYjjyTOPWq6OrmtA==",
"WebhookSignature": "Timestamp:2024-03-25T23:17:35Z Signature:7QM6Le7lx50AIBtoHMbGx4oCUms0/RkOV9IyMa3MaA8V6cuaUQ9K9QQlWZLCMjUaKEphD7KBypbq6sYirn/00g==",
"EventId": 163066000,
"EventType": "profile.reactivated",
"Subject": "profile.reactivated",
"Entity": "Profile",
"SubscriptionId": 41,
"Name": "profile.reactivated",
"Description": "profile.reactivated Description",
"ProfileId": 726175,
"Data": {
"ProfileReactivated": true
},
"AppVersion": 1,
"EventTime": "2024-03-25T23:17:34.257Z",
"CreateDate": "2024-03-25T23:17:34.117Z",
"CreatedBy": "My Accounts Page"
}
] Profile Deleted: The profile.deleted is triggered when a contact is permanently removed from MyPreferences. Subscribing to these events proves valuable in scenarios where there's a necessity to receive notifications regarding data erasure requests as mandated by regulations such as GDPR or other privacy policies. This allows you to maintain compliance and honor customer's request to permanently remove their personal data.
[
{
"Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e",
"WebhookProxyRandomValue": "rXU14sWEqxX/SWLqbSpfI78yipk+zb0+DW89svYi",
"WebhookProxyHashSignature": "bsoHc9lGEZqNWK+8KLqntspXe//OVReoWUZwM86wNuTkAE8/9TAzSAxlimWntU0tUbj8bAVP/bKxc+4X/Ki4CA==",
"WebhookSignature": "Timestamp:2024-03-25T23:29:54Z Signature:VvuIlLQjZygMNmN3B/1Iu6K3sKkkxdcRwWXCLAMRrifGwJesSJ63To3MYd48FFUIWI7jwmO1AwaeYKFeCc+Fyg==",
"EventId": 163120000,
"EventType": "profile.deleted",
"Subject": "profile.deleted",
"Entity": "Profile",
"SubscriptionId": 41,
"Name": "profile.deleted",
"Description": "profile.deleted Description",
"ProfileId": 726175,
"Data": {
"ReasonCode": "Fulfillment of deletion request",
"ProfileDeleted": true
},
"AppVersion": 1,
"OriginalEventTime": "2024-03-25T23:29:53.693Z",
"EventTime": "2024-03-25T23:29:54.693Z",
"CreateDate": "2024-03-25T23:29:54.690Z",
"CreatedBy": "My Accounts Page"
}
] Profile Updated: The profile.updated event is an informational event that's generated each time a profile is updated.
[
{
"Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e",
"WebhookProxyRandomValue": "g7U2IW+KCfsq//zuUIDQCnfkWtk6K2+6ZpYslXsuTl+rKOJJ9cNtGVZmWrIM",
"WebhookProxyHashSignature": "Tf/AabnOi1SunM/L1gRNOPCGDS0SkfIU4No+fZ410Jch7jz2Uf+bLj9R4wcO/5Yeihzw240EEyezKUpBsYkV2Q==",
"WebhookSignature": "Timestamp:2024-03-26T20:35:06Z Signature:yVznlNGG5zA0YMdXGF/nI46jrWQhm68ofj3DzCwAmkjFAb3lrpbhlPw+Oi9iqGindFXNHS4HzZWCj4ePsJnn8A==",
"EventId": 172614000,
"EventType": "profile.updated",
"Subject": "profile.updated",
"Entity": "Profile",
"SubscriptionId": 41,
"Name": "profile.updated",
"Description": "profile.updated Description",
"ProfileId": 18807,
"Data": {},
"AppVersion": 1,
"OriginalEventTime": "2024-03-25T23:29:53.693Z",
"EventTime": "2024-03-26T20:35:05.350Z",
"CreateDate": "2024-03-26T20:35:05.327Z",
"CreatedBy": "My Accounts Page"
}
] What made this section unhelpful for you?
Preferences
Preferences play a pivotal role in personalizing user experiences and tailoring interactions to individual preferences. In a dynamic digital landscape, it's essential to have real-time insights into changes in user preferences to enhance engagement and satisfaction. Our preferences webhook events offer a seamless way to stay updated on these changes, ensuring your systems are always aligned with the latest user preferences.
Preference events are only triggered for Filters associated with your webhook subscription. To receive events across all Filters, specify "AllFilters” when creating your webhook subscription.
{
"Entity": "Preferences",
"EventType": "preference.added",
"Filters": [
"AllFilters"
]
}
Preference Added: The preference.added event is triggered any time a new preference gets added to a profile.
[ { "Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e", "WebhookProxyRandomValue": "c/pDPxXyh2kFQKMekAFeXN9MQr+Cq8sCKt1REleS8jFDVvruQq/1wWZAq6vmlioRCQ==", "WebhookProxyHashSignature": "x6ouFD2I5SBmrxoeuiSxb/uwvQy6RNOT5R8s5Azyegw7FFavT8Ir773eE88Pv4YXZjB4Qvlvtpxykrjt0C2+6Q==", "WebhookSignature": "Timestamp:2024-03-30T03:23:51Z Signature:1ooWts6lx0YnxW7dD929ENVq3vTQE8QJj4zBtcXMBylUm6J8emqbwMJ4LXIpm90AQGf3pjSsoNVHFP27bUqIsw==", "EventId": 175590000, "EventType": "preference.added", "Subject": "preference.added", "Entity": "Preferences", "SubscriptionId": 41, "Name": "preference.added", "Description": "preference.added Description", "ProfileId": 18807, "Data": { "FilterID": "EM_PROD_INSIGHTS", "PreferenceType": "Opt-In", "FilterName": "Product Insights and Updates", "TypeName": "Home", "LastModifiedDate": "2024-03-30T03:23:49.533Z", "CustomerDate": "2024-03-30T03:23:44.000Z", "SourceId": "Preference Center", "Frequency": "Weekly", "Channel": "Email", "ProgramId": "PROD_INSIGHTS", "ProgramName": "Product Insights and Updates", "EmailAddress": "john.doe@example.com", "IsDefault": false, "ReasonCode": "" }, "AppVersion": 1, "OriginalEventTime": "2024-03-30T03:23:47.713Z", "EventTime": "2024-03-30T03:23:49.713Z", "CreateDate": "2024-03-30T03:23:49.533Z", "CreatedBy": "My Accounts Page" }]Preference Updated: The preference.updated event is triggered each time a preference record is updated. This not only include updates to the preference type or preference status, but also updates to preference attributes, frequencies and other fields that are a part of the preference. Preference events do not account for consent associations with preferences. You must subscribe to consent.filterassociation events to receive updates when a consent gets associated with a preference.
[ { "Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e", "WebhookProxyRandomValue": "ffvN83/UnmVmu1J3QhvZMa0eE2dlQEFSLmB2numkjFyuzMCj", "WebhookProxyHashSignature": "C+uVQyYLzFBl5oDTG1A6/S4CSEAK9Hg6kmPDOItXH8Ovz7weN3OsBczoL6UkPWLP7LcTidzEjuFE1b1gSAaxSA==", "WebhookSignature": "Timestamp:2024-03-30T03:37:09Z Signature:onEV+qdOoy5XGUy5HaCBU21IU5A5Ju05YLAfKXDa9Fqhn8C8pPIKAJR2a+c7dq4AqW1H274pQJmmYE7cK4ntyQ==", "EventId": 175648000, "EventType": "preference.updated", "Subject": "preference.updated", "Entity": "Preferences", "SubscriptionId": 41, "Name": "preference.updated", "Description": "preference.updated Description", "ProfileId": 18807, "Data": { "FilterID": "EM_PROD_INSIGHTS", "PreferenceType": "Opt-In", "FilterName": "Product Insights and Updates", "TypeName": "Home", "LastModifiedDate": "2024-03-30T03:37:09.573Z", "CustomerDate": "2024-03-30T03:37:02.000Z", "SourceId": "Default", "Frequency": "Weekly", "Channel": "Email", "ProgramId": "PROD_INSIGHTS", "ProgramName": "Product Insights and Updates", "EmailAddress": "john.doe@example.com", "IsDefault": false, "ReasonCode": "" }, "AppVersion": 1, "OriginalEventTime": "2024-03-30T03:37:09.613Z", "EventTime": "2024-03-30T03:37:09.613Z", "CreateDate": "2024-03-30T03:37:09.573Z", "CreatedBy": "My Accounts Page" }]Preference Archived: The preference.archived event is triggered each time a preference is archived within MyPreferences. Preference archival occurs for various reasons, such as when a contact element is removed with PreservePreferences flag set to false, or the consent associated with the preference gets revoked. Additionally, changing the IsMobile value on a phone number from true to false will also archive any SMS preferences associated with that phone number.
[ { "Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e", "WebhookProxyRandomValue": "vqY2Sd1aktmoAQnUJVS0nOeVzR+8hnUN1t8Xxnu/0Q==", "WebhookProxyHashSignature": "KUg6Qe7PCWRVvG25iPdcYxMWq+k8NQR0cyFU4tkNrHT/7E6amPnZdf9YZYnVSQ1nFfo8dk8bKCD4xXoyqY/2hg==", "WebhookSignature": "Timestamp:2024-03-29T20:17:56Z Signature:SQMZc9w8L44OfHis0ytcnIffF08/nz7jK/iWcJPyfClqHKQWvE++9uLBWFSOLlGmqlRLy1NUhhDmzyF0W7Jp/A==", "EventId": 175073000, "EventType": "preference.archived", "Subject": "preference.archived", "Entity": "Preferences", "SubscriptionId": 41, "Name": "preference.archived", "Description": "preference.archived Description", "ProfileId": 18807, "Data": { "FilterID": "EM_PROD_INSIGHTS", "PreferenceType": "Opt-In", "FilterName": "Product Insights and Updates", "TypeName": "Home", "LastModifiedDate": "2024-03-29T20:11:04.777Z", "CustomerDate": "2024-03-29T20:11:03.000Z", "SourceId": "Default", "Frequency": "Default", "Channel": "Email", "ProgramId": "PROD_INSIGHTS", "ProgramName": "Product Insights and Updates", "EmailAddress": "john.doe@example.com", "IsDefault": false, "ReasonCode": "Deactivated due to Revocation of Consent" }, "AppVersion": 1, "OriginalEventTime": "2024-03-29T20:17:54.270Z", "EventTime": "2024-03-29T20:17:55.270Z", "CreateDate": "2024-03-29T20:11:04.777Z", "CreatedBy": "My Accounts Page" }]What made this section unhelpful for you?
Consents
Consent is pivotal in modern data-driven interactions, ensuring user privacy and regulatory compliance. Our consent webhook events offer concise updates on changes in user consents throughout their customer journey, providing essential insights for regulatory compliance and user privacy management.
Consent events are only triggered for consents associated with your webhook subscription. To receive events across all consents, specify "AllConsents” when creating your webhook subscription.
{ "Entity": "Consents", "EventType": "consent.status.updated", "ConsentTypes": [ "AllConsents" ] }
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
What made this section unhelpful for you?
Contacts
Contact webhook events are designed to empower you with timely insights into the evolution of contact information on your customer and non-customer profiles. Whether an email is added, updated, or deleted, or if changes occur in phone numbers or addresses, you can subscribe to receive notifications for these updates, covering the essential contact details that drive communication and engagement with your audience.
Additionally, the Contacts entity also cover events for Alternate Ids and Customer Types.
Contacts events are only triggered for contact types associated with your webhook subscription. To receive events across all contact types, specify "AllContactTypes” when creating your webhook subscription.
{
"Entity": "Contacts",
"EventType": "contacts.email.added",
"ContactTypes": [
"AllContactTypes"
]
}
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
What made this section unhelpful for you?
Standard Fields
Standard fields serve as essential building blocks for profile records, enabling accurate identification, communication, and customization of interactions based on individual preferences and linguistic needs. The Events Webhook framework supports tracking of updates to standard contact fields, empowering you to stay informed about changes to essential contact details.
Below is an overview of the webhook events generated for standard fields.
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
Select...
What made this section unhelpful for you?
Custom Fields
Custom fields are user-defined data fields that allow you to tailor data storage and organization according to your specific customer experience use cases. These fields can be customized to capture various types of information, such as text, numbers, dates, or selections from predefined lists. Custom fields provide the flexibility needed to enrich your customer profiles through continuous zero-party data collection efforts.
The custom field events enable real-time notifications for actions involving custom fields. Whether you're adding, updating, or removing a custom field, our webhooks ensure you stay informed instantly, facilitating seamless integration and data management within your systems.
Select...
Select...
Select...
What made this section unhelpful for you?
Groups
Groups are used to connect a set of profiles based on collective interests and characteristics. The group events enable real-time notifications for actions involving groups. Whether you're adding, updating, or removing a group, our webhooks ensure you stay informed instantly, facilitating seamless integration and data management within your systems.
Below is an overview of the webhook events generated for groups.
Select...
Select...
Select...
What made this section unhelpful for you?
Tags
Tags help you organize your profiles based on specific pieces of information associated with a profile. The tag events enable real-time notifications for actions involving tags. Whether you're adding, updating, or removing a tag, our webhooks ensure you stay informed instantly, facilitating seamless integration and data management within your systems.
Below is an overview of the webhook events generated for tags.
Select...
Select...
What made this section unhelpful for you?
Create new subscription
This method allows you to create a new webhook subscription. You can subscribe to one or more of the available event types associated with the supported entities. Click here to see the complete list of supported event types.
Check out subscription examples for various entities in the samples window on the right.
Deactivating a subscription by setting the IsActive property to false will result in its deletion. Please deactivate a subscription only when you no longer wish to receive event notifications. If you wish to temporarily pause event notifications, you can achieve this by using the 'State' parameter and setting it to 'Paused'.
Sample Webhook Subscription Request
The sample below illustrates an event subscription request. It's crucial to understand that the following entities provide event generation for all their instances. For example, if you want to receive notifications whenever a preference is added to any filter within your MyPreferences account, simply specify 'AllFilters' in the 'Filters' array when subscribing to the preference.added event. However, if you only want to receive events for selective Filters, list the Filter ID's of those Filters in the ‘Filters’ array within your subscription request.
- Preferences : [AllFilters]
- Consents: [AllConsents]
- Contacts: [AllContactTypes]
- Groups: [AllGroups]
- Custom Fields: [AllCustomFields]
{ "Name": "Webhook - Consent and Preference Updates", "Description": "consent and preference data updates", "LocaleID": "en_US", "Url": "https://eowju7xe3jismp9.m.mywehookURL.net/", "Subscriptions": [ { "Entity": "Contacts", "EventType": "contacts.alternateid.added", "ContactTypes": [ "AllContactTypes" ] }, { "Entity": "Consents", "EventType": "consent.added", "ConsentTypes": [ "AllConsents" ] }, { "Entity": "Consents", "EventType": "consent.deactivated", "ConsentTypes": [ "AllConsents" ] }, { "Entity": "Consents", "EventType": "consent.elementassociation.created", "ConsentTypes": [ "AllConsents" ] }, { "Entity": "Consents", "EventType": "consent.elementassociation.updated", "ConsentTypes": [ "AllConsents" ] }, { "Entity": "Consents", "EventType": "consent.filterassociation.created", "ConsentTypes": [ "AllConsents" ] }, { "Entity": "Consents", "EventType": "consent.filterassociation.updated", "ConsentTypes": [ "AllConsents" ] }, { "Entity": "Consents", "EventType": "consent.elementassociation.deactivated", "ConsentTypes": [ "AllConsents" ] }, { "Entity": "Consents", "EventType": "consent.filterassociation.deactivated", "ConsentTypes": [ "AllConsents" ] }, { "Entity": "Consents", "EventType": "consent.updated", "ConsentTypes": [ "AllConsents" ] }, { "Entity": "Contacts", "EventType": "contacts.address.added", "ContactTypes": [ "AllContactTypes" ] }, { "Entity": "Contacts", "EventType": "contacts.address.deleted", "ContactTypes": [ "AllContactTypes" ] }, { "Entity": "Contacts", "EventType": "contacts.address.updated", "ContactTypes": [ "AllContactTypes" ] }, { "Entity": "Contacts", "EventType": "contacts.email.added", "ContactTypes": [ "AllContactTypes" ] }, { "Entity": "Contacts", "EventType": "contacts.email.deleted", "ContactTypes": [ "AllContactTypes" ] }, { "Entity": "Contacts", "EventType": "contacts.email.updated", "ContactTypes": [ "AllContactTypes" ] }, { "Entity": "Contacts", "EventType": "contacts.phone.updated", "ContactTypes": [ "Personal", "Work" ] }, { "Entity": "CustomFields", "EventType": "customfield.added", "CustomFields": [ "AllCustomFields" ] }, { "Entity": "CustomFields", "EventType": "customfield.deleted", "CustomFields": [ "AllCustomFields" ] }, { "Entity": "CustomFields", "EventType": "customfield.updated", "CustomFields": [ "AllCustomFields" ] }, { "Entity": "Groups", "EventType": "group.added", "Groups": [ "AllGroups" ] }, { "Entity": "Groups", "EventType": "group.deactivated", "Groups": [ "AllGroups" ] }, { "Entity": "Groups", "EventType": "group.updated", "Groups": [ "AllGroups" ] }, { "Entity": "Preferences", "EventType": "preference.added", "Filters": [ "AllFilters" ] }, { "Entity": "Preferences", "EventType": "preference.archived", "Filters": [ "AllFilters" ] }, { "Entity": "Preferences", "EventType": "preference.updated", "Filters": [ "AllFilters" ] }, { "Entity": "ProfileActions", "EventType": "profile.created" }, { "Entity": "ProfileActions", "EventType": "profile.updated" }, { "Entity": "ProfileActions", "EventType": "profile.deleted" }, { "Entity": "Tags", "EventType": "tag.added" }, { "Entity": "Tags", "EventType": "tag.deleted" }, { "Entity": "StandardFields", "EventType": "standardfield.defaultlocale.updated" }, { "Entity": "StandardFields", "EventType": "standardfield.registrationstatus.updated" } ], "IsMinimized": false, "State": "Active", "IsActive": true}Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Path Parameters
This is your organization’s MyPreferences account Id.
Body Parameters
Name of the subscription.
Description of the subscription.
LocaleId used to return localized name and description for the event.
URL associated with the subscription to receive POST requests for events. Only secure (htttps) URL's are supported
The status of the subscription whether it's active and sending notifications, paused, or inactive. If you don't specify a state with your request, the default state of "Paused" will be applied.
ActivePausedInactiveIf set to true, the event notifications will only include the main event information without any data associated with it. Receiving systems must retrieve the data by other means.
Indicates whether the webhook subscription is active or not. Deactivating a subscription will result in its deletion. Please deactivate a subscription only when you no longer wish to receive event notifications. If you wish to temporarily pause event notifications, you can achieve this by using the 'State' parameter and setting it to 'Paused'.
Collection of event subscriptions. Check out subscription examples for various entities in the upper right corner.
Show child attributes
Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.
Response
Response Attributes
System generated read-only value that uniquely identifies the webhook subscription.
Name of the webhook subscription.
Description of the webhook subscription
LocaleId used to return localized name and description for the event.
Url associated with the subscription to receive HTTP POST requests. Only HTTPS URL's are supported.
Collection of event subscriptions.
Show child attributes
The status of the subscription whether it's active and sending notifications, paused, or inactive.
If set to true, the event notifications will only include the main event information without any data associated with it. Receiving systems must retrieve the data by other means.
Indicates whether the webhook subscription is active or not.
Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.
Response Attributes
Tags
TagsContacts
Contacts Show child attributes
Profile
ProfileActionsPreferences
PreferencesFilter ID's associated with the Filters you want to subscribe. When subscribing to all Filters, specify 'AllFilters'
Show child attributes
StandardFields
StandardFieldsConsents
ConsentsType Names of the Consents you want to subscribe. When subscribing to all Consents, specify 'AllConsents'
Show child attributes
Groups
GroupsNames of the Groups you want to subscribe. When subscribing to all Groups, specify 'AllGroups'
Show child attributes
CustomFields
CustomFieldsNames of the custom fields you want to subscribe. When subscribing to all custom fields, specify 'AllCustomFields'
Show child attributes
What made this section unhelpful for you?
Response
{
"Id": 170,
"Name": "Consent and Preference Updates",
"Description": "Webhook subscription for receiving preference and consent status updates",
"LocaleId": "en_US",
"Url": "https://webhook.com/myreceivingurl",
"Subscriptions": [
{
"Entity": "Contacts",
"EventType": "contacts.alternateid.added",
"ContactTypes": [
"AllContactTypes",
"AllContactTypes"
]
},
{
"Entity": "Contacts",
"EventType": "contacts.customertype.updated",
"ContactTypes": [
"AllContactTypes"
]
}
],
"State": "Active",
"IsMinimized": "false",
"IsActive": true,
"AlternateIdType": "SalesforceId"
}Status Codes
200
Everything worked as expected.
400
The request was unacceptable, often due to missing a required parameter.
401
The request was unacceptable, often due to missing a required parameter.
402
The parameters were valid but the request failed.
403
The API key doesnt have permissions to perform the request.
404
The requested resource does not exist.
What made this section unhelpful for you?
Update subscription
This method allows you to update an existing webhook subscription by specifying the subscriptionId as the path parameter in your request.
Deactivating a subscription will result in its deletion. Please deactivate a subscription only when you no longer wish to receive event notifications.
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Path Parameters
This is your organization’s MyPreferences account Id.
Id of the webhook subscription you want to update.
Body Parameters
Name of the subscription.
Description of the subscription.
LocaleId used to return localized name and description for the event.
URL associated with the subscription to receive POST requests for events. Only secure (htttps) URL's are supported
The status of the subscription whether it's active and sending notifications, paused, or inactive.
ActiveInactiveIf set to true, the event notifications will only include the main event information without any data associated with it. Receiving systems must retrieve the data by other means.
Indicates whether the webhook subscription is active or not.
Collection of event subscriptions.
Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.
Response
Response Attributes
Name of the webhook subscription.
Description of the webhook subscription
LocaleId used to return localized name and description for the event.
Url associated with the subscription to receive HTTP POST requests. Only HTTPS URL's are supported.
Collection of event subscriptions.
The status of the subscription whether it's active and sending notifications, paused, or inactive.
If set to true, the event notifications will only include the main event information without any data associated with it. Receiving systems must retrieve the data by other means.
Indicates whether the webhook subscription is active or not.
Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.
Response Attributes
Tags
TagsContacts
Contacts Show child attributes
Profile
ProfileActionsPreferences
PreferencesFilter IDs of the Filters you want to subscribe. When subscribing to all Filters, specify 'AllFilters'
Show child attributes
StandardFields
StandardFieldsConsents
ConsentsType Names of the Consents you want to subscribe. When subscribing to all Consents, specify 'AllConsents'
Show child attributes
Groups
GroupsNames of the Groups you want to subscribe. When subscribing to all Groups, specify 'AllGroups'
Show child attributes
CustomFields
CustomFieldsNames of the custom fields you want to subscribe. When subscribing to all custom fields, specify 'AllCustomFields'
Show child attributes
What made this section unhelpful for you?
Response
{
"Name": "Consent and Preference Updates",
"Description": "Webhook subscription for receiving preference and consent status updates",
"LocaleId": "en_US",
"Url": "https://webhook.com/myreceivingurl",
"Subscriptions": [],
"State": "Active",
"IsMinimized": "false",
"IsActive": true,
"AlternateIdType": "SalesforceId"
}What made this section unhelpful for you?
Retrieve subscriptions
This method allows you to retrieve all webhook subscriptions. You can choose to specify the SubscriptionId as a query parameter to retrieve a specific subscription.
Subscriptions that have been paused or inactive will also be returned.
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Query Parameters
(Optional) The id of the webhook subcription you want to retrieve. If omitted, all subscriptions will be returned.
Path Parameters
This is your organization’s MyPreferences account Id.
Response
Response Attributes
System generated read-only value that uniquely identifies the webhook subscription.
Name of the subscription.
Description of the subscription.
LocaleId used to return localized name and description for the event.
URL associated with the subscription to receive POST requests for events. Only secure (htttps) URL's are supported.
Collection of event subscriptions.
The status of the subscription whether it's active and sending notifications, paused, or inactive.
ActivePausedInactiveIf set to true, the event notifications will only include the main event information without any data associated with it. Receiving systems must retrieve the data by other means.
Indicates whether the webhook subscription is active or not.
Type Name associated with an active AlternateId Type. If available, will be returned instead of the profileId.
Response Attributes
What made this section unhelpful for you?
Response
[
{
"Id": 170,
"Name": "Consent and Prefrence Updates",
"Description": "Webhook subscription for receiving preference and consent status updates",
"LocaleId": "en_US",
"Url": "https://webhook.com/myreceivingurl",
"Subscriptions": [],
"State": "Active",
"IsMinimized": "false",
"IsActive": true,
"AlternateIdType": "SalesforceId"
}
]What made this section unhelpful for you?
Delete subscription
This method deletes the webhook subscription identified by the subscriptionId parameter.
Deleting the subscription is currently an irrevocable operation. This means that you cannot reinstate the webhook subscription. This operation should only be performed if the subscription is no longer needed. To pause or temporarily turn off webhook notifications, set the State property to either Paused or Inactive using the Update Subscription method.
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Path Parameters
This is your organization’s MyPreferences account Id.
The (integer) id of the webhook subscription.
Response
Response Attributes
Response Attributes
Response Attributes
Response Attributes
What made this section unhelpful for you?
Response
No ContentWhat made this section unhelpful for you?
Update webhook settings
This method allows you to update webhook message delivery settings.
The MaxConcurrentRequests determines the maximum number of messages that the EventsPublisherService will process in a single service cycle. It reads up to this specified number of messages and then sends them to the designated receiving URLs configured across all active webhook subscriptions.
Following the processing of these messages, the service engages in a "pause" based on the time specified under the Duration property. This means that after handling the specified number of messages, the service takes a break for the duration indicated before it resumes its cycle and processes additional messages.
The default settings for Max Concurrent Requests is "500", and Duration (in seconds) is "1".
- The Min value for "Max Concurrent Requests" can be set to "50".
- The Min value for "Duration (in seconds)" can be set to "1".
- The Max value for "Max Concurrent Requests" can be set to "5000".
- The Max value for "Duration (in seconds)" can be set to "300".
This setting is an account-level setting and applies to all webhook subscriptions within your MyPreferences account.
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Path Parameters
This is your organization’s MyPreferences account Id.
Body Parameters
Webhook message delivery settings.
Show child attributes
Includes resource creation and modification details to track changes and auditability within MyPreferences.
Show child attributes
Response
Response Attributes
Webhook message delivery settings.
Show child attributes
Includes resource creation and modification details to track changes and auditability within MyPreferences.
Show child attributes
Response Attributes
Response Attributes
Response Attributes
Response Attributes
What made this section unhelpful for you?
Response
{
"Settings": {
"MaxConcurrentRequests": 50,
"Duration": 10
},
"Edited": {
"CreateDate": "2023-05-16T15:24:08.743",
"CreatedBy": "Webhook API User",
"ModifiedDate": "2023-06-16T15:24:08.743",
"ModifiedBy": "Webhook API User"
}
}What made this section unhelpful for you?
Retrieve webhook settings
This method allows you to retrieve webhook message delivery settings.
This setting is an account-level setting and applies to all webhook subscriptions within your MyPreferences account.
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Path Parameters
This is your organization’s MyPreferences account Id.
Response
Response Attributes
Webhook message delivery settings.
Show child attributes
Includes resource creation and modification details to track changes and auditability within MyPreferences.
Show child attributes
Response Attributes
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
Response Attributes
Response Attributes
Response Attributes
What made this section unhelpful for you?
Response
{
"Settings": {
"MaxConcurrentRequests": 50,
"Duration": 10
},
"Edited": {
"CreateDate": "2023-05-16T15:24:08.743",
"CreatedBy": "Webhook API User",
"ModifiedDate": "2023-06-16T15:24:08.743",
"ModifiedBy": "Webhook API User"
}
}What made this section unhelpful for you?
Retrieve events
This method allows you to retrieve events across all webhook subscriptions associated with your MyPreferences account.
It offers an optional query parameter locale that returns the event name and description for the specified locale id. Contact support@possiblenow.com with localized names and description for locales you want to use. If the localized name and description is not configured for the specified locale, the API will return the event name and description in your account's default locale. A future update will provide an API for programmatic management of these updates.
The startAt parameter must be set before endAt and should not exceed the MaxEventHistoryDays setting of 180 days. If the startAt parameter is not specified, the API defaults it to MaxEventHistoryDays.
All API users must have the Event Data - > View Permission enabled within their User Groups.
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Query Parameters
Optional parameter used for returning the event name and description in the specified locale. If not supplied, the client's default locale will be used.
Optional parameter used to limit the events returned to a specific event type.
Optional datetime. Events created before this datetime will not be returned.
Optional datetime. Events created after this datetime will not be returned.
Collection of Source Group IDs specified as an indexed array.
Show child attributes
Optional parameter that when set to true only returns events that are associated with an active subscription. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Response
Response Attributes
System-generated identifier that uniquely identifies an event.
Represents the type of action that occured. It's synonymous with an event.
An allocated field within the event data structure, reserved for advanced event filtering for routing purposes.
Name of the entity associated with the event.
Uniquely identifies the subscription for which the events are being retrieved for
Name of the event.
Description of the event.
This is the value that uniquely identifies the profile for which the events are being retrieved.
Data pertaining to a particular event. It is encapsulated as a nested object with its individual key-value pairs within the Events JSON structure.
Show child attributes
The date and time when the event occurred.
The date and time when the event was queued for distribution.
The date and time the event was recorded in the system.
The name of the user who recorded the event.
Response Attributes
What made this section unhelpful for you?
Response
[
{
"EventId": "132029848000",
"EventType": "contacts.email.added",
"Subject": "contacts.email.added",
"Entity": "Contacts",
"SubscriptionId": "Contact Update Notifications",
"Name": "contacts.email.added",
"Description": "contacts.email.added",
"ProfileId": 49339343,
"Data": {
"EmailAddress": "john.doe@example.com",
"EmailAddressType": "Home",
"IsDefault": false
},
"OriginalEventTime": "2023-11-09T19:44:12.543",
"EventTime": "2023-11-09T19:44:12.543",
"CreateDate": "2023-11-09T19:44:12.450",
"CreatedBy": "My Account Portal"
}
]What made this section unhelpful for you?
Retrieve events by subscription id
This method allows you to retrieve events associated with a specific subscriptionId.
It offers an optional query parameter locale that returns the event name and description for the specified locale id. Contact support@possiblenow.com with localized names and description for locales you want to use. If the localized name and description is not configured for the specified locale, the API will return the event name and description in your account's default locale. A future update will provide an API for programmatic management of these updates.
The startAt parameter must be set before endAt and should not exceed the MaxEventHistoryDays setting of 180 days. If the startAt parameter is not specified, the API defaults it to MaxEventHistoryDays.
All API users must have the Event Data - > View Permission enabled within their User Groups.
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Query Parameters
Optional parameter used for returning the event name and description in the specified locale. If not supplied, the client's default locale will be used.
Optional parameter used to limit the events returned to a specific event type.
Optional datetime. Events created before this datetime will not be returned.
Optional datetime. Events created after this datetime will not be returned.
Collection of Source Group IDs specified as an indexed array.
Show child attributes
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
This is the value that uniquely identifies the subscription for which the events are being retrieved for.
Response
Response Attributes
System-generated identifier that uniquely identifies an event.
Represents the type of action that occured. It's synonymous with an event.
An allocated field within the event data structure, reserved for advanced event filtering for routing purposes.
Name of the entity associated with the event.
Uniquely identifies the subscription for which the events are being retrieved for
Name of the event.
Description of the event.
This is the value that uniquely identifies the profile for which the events are being retrieved.
Data pertaining to a particular event. It is encapsulated as a nested object with its individual key-value pairs within the Events JSON structure.
Show child attributes
The date and time when the event occurred.
The date and time when the event was queued for distribution.
The date and time the event was recorded in the system.
The name of the user who recorded the event.
Response Attributes
What made this section unhelpful for you?
Response
[
{
"EventId": "132029848000",
"EventType": "contacts.email.added",
"Subject": "contacts.email.added",
"Entity": "Contacts",
"SubscriptionId": "Contact Update Notifications",
"Name": "contacts.email.added",
"Description": "contacts.email.added",
"ProfileId": 49339343,
"Data": {
"EmailAddress": "john.doe@example.com",
"EmailAddressType": "Home",
"IsDefault": false
},
"OriginalEventTime": "2023-11-09T19:44:12.543",
"EventTime": "2023-11-09T19:44:12.543",
"CreateDate": "2023-11-09T19:44:12.450",
"CreatedBy": "My Account Portal"
}
]What made this section unhelpful for you?
Retrieve events by profile id
This method allows you to retrieve events for a specific profile. It is designed to facilitate customer experiences that display recent actions performed by an individual on their profile.
It provides a range of optional query parameters, enabling you to filter events based on a specific event type, the source capturing the event, the event's date and time, and the locale.
EventType: Returns events for the specified event type. Example: EventType=profile.deleted.
StartAt and EndAt: Returns events for the dates specified.
- Including
StartAtreturns events equal to or greater than than the provided date. - Including
EndAtreturns events equal to or less than the provided date. - If both values are provided, the search will return the events between the specified values. If both values are not provided, the search is inclusive of all dates.
The startAt parameter must be set before endAt and should not exceed the MaxEventHistoryDays setting of 180 days. If the startAt parameter is not specified, the API defaults it to MaxEventHistoryDays.
SourceGroupIds: Returns events for the specified Source Group Id's. Use this parameter if you are interested in receiving events that were recorded by a specific data source. Example: Cookie Preference Center.
Locale: Returns the event name and description in the specified locale. Contact support@possiblenow.com with the list of localized names and description for locales you want to use. A future update will provide an API for programmatic management of these updates.
All API users must have the Event Data - > View Permission enabled within their User Groups.
Sample Events Request
The sample below illustrates an events retrieval request for a profile Id. The results are returned based on the events associated with the profile and also account for any optional query parameters specified.
[
{
"EventId": "178319000",
"EventType": "profile.created",
"Subject": "profile.created",
"Entity": "Profile",
"Name": "profile.created",
"Description": "profile.created",
"ProfileId": 726195,
"Data": {
"ProfileId": 726195,
"IsActive": true,
"Edited": {
"CreateDate": "2024-04-03T18:32:47.137Z",
"CreatedBy": "My Accounts Page"
},
"RegistrationConfirmed": false,
"CustomerType": "Lead",
"PreserveConsents": true,
"PreservePreferences": true,
"CustomerName": {},
"DefaultLocale": "en_US",
"UpdateStatus": "Complete"
},
"OriginalEventTime": "2024-04-03T18:32:47.190",
"EventTime": "2024-04-03T18:32:47.190",
"CreateDate": "2024-04-03T18:32:47.137",
"CreatedBy": "My Accounts Page"
},
{
"EventId": "178387000",
"EventType": "contacts.customertype.updated",
"Subject": "contacts.customertype.updated",
"Entity": "Contacts",
"Name": "contacts.customertype.updated",
"Description": "contacts.customertype.updated",
"ProfileId": 726195,
"Data": {
"CustomerType": "Customer"
},
"OriginalEventTime": "2024-04-03T18:32:47.190",
"EventTime": "2024-04-03T18:33:02.640",
"CreateDate": "2024-04-03T18:32:47.137",
"CreatedBy": "My Accounts Page"
},
{
"EventId": "178388000",
"EventType": "profile.updated",
"Subject": "profile.updated",
"Entity": "Profile",
"Name": "profile.updated",
"Description": "profile.updated",
"ProfileId": 726195,
"OriginalEventTime": "2024-04-03T18:32:47.190",
"EventTime": "2024-04-03T18:33:02.640",
"CreateDate": "2024-04-03T18:33:02.603",
"CreatedBy": "My Accounts Page"
},
{
"EventId": "178461000",
"EventType": "contacts.email.added",
"Subject": "contacts.email.added",
"Entity": "Contacts",
"Name": "contacts.email.added",
"Description": "contacts.email.added",
"ProfileId": 726195,
"Data": {
"EmailAddress": "john.doe@example.com",
"EmailAddressType": "Personal",
"IsDefault": false
},
"OriginalEventTime": "2024-04-03T18:32:47.190",
"EventTime": "2024-04-03T19:36:35.857",
"CreateDate": "2024-04-03T19:36:35.810",
"CreatedBy": "My Accounts Page"
}
] Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Query Parameters
Optional parameter used to limit the events returned to a single type.
Optional datetime. Events created before this datetime will not be returned.
Optional datetime. Events created after this datetime will not be returned.
Collection of Source Group IDs specified as an indexed array.
Show child attributes
Optional parameter used for returning the event name and description in the specified locale. If not specified, the default locale assigned to your MyPreferences account will be used.
Optional parameter that when set to true only returns events that are associated with an active subscription. Defaults to true.
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
This is the value that uniquely identifies the profile for which the events are being retrieved.
Response
Response Attributes
System-generated identifier that uniquely identifies an event.
Represents the type of action that occured. It's synonymous with an event.
An allocated field within the event data structure, reserved for advanced event filtering for routing purposes.
Name of the entity associated with the event.
Uniquely identifies the subscription for which the events are being retrieved for
Name of the event.
Description of the event.
This is the value that uniquely identifies the profile for which the events are being retrieved.
Data pertaining to a particular event. It is encapsulated as a nested object with its individual key-value pairs within the Events JSON structure.
Show child attributes
The date and time when the event occurred.
The date and time of the event generation.
The date and time the event was recorded in the system.
The name of the user who recorded the event.
Response Attributes
What made this section unhelpful for you?
Response
[
{
"EventId": "132029848000",
"EventType": "contacts.email.added",
"Subject": "contacts.email.added",
"Entity": "Contacts",
"SubscriptionId": "Contact Update Notifications",
"Name": "contacts.email.added",
"Description": "contacts.email.added",
"ProfileId": 49339343,
"Data": {
"EmailAddress": "john.doe@example.com",
"EmailAddressType": "Home",
"IsDefault": false
},
"OriginalEventTime": "2023-11-09T19:44:10.143",
"EventTime": "2023-11-09T19:44:12.543",
"CreateDate": "2023-11-09T19:44:12.450",
"CreatedBy": "My Account Portal"
}
]What made this section unhelpful for you?
Retrieve event by event id
This method allows you to retrieve a specific event by specifying the eventId. It is designed to facilitate event playbacks for verification and audit purposes.
It offers an optional query parameter locale that returns the event name and description for the specified locale id. Contact support@possiblenow.com with localized names and description for locales you want to use. If the localized name and description is not configured for the specified locale, the API will return the event name and description in your account's default locale. A future update will provide an API for programmatic management of these updates.
All API users must have the Event Data - > View Permission enabled within their User Groups.
Header Parameters
Authorization token
Type of the data being sent in the request or the data that is expected in the response. Supports application/json.
Query Parameters
Path Parameters
This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.
Unique identifier of the event
Response
Response Attributes
System-generated identifier that uniquely identifies an event.
Represents the type of action that occured. It's synonymous with an event.
An allocated field within the event data structure, reserved for advanced event filtering for routing purposes.
Name of the entity associated with the event.
Name of the event.
Description of the event.
This is the value that uniquely identifies the profile for which the events are being retrieved.
Data pertaining to a particular event. It is encapsulated as a nested object with its individual key-value pairs within the Events JSON structure.
Show child attributes
The date and time when the event occurred.
The date and time when the event was queued for distribution.
The date and time the event was recorded in the system.
The name of the user who recorded the event.
Response Attributes
What made this section unhelpful for you?
Response
[
{
"EventId": "132029848000",
"EventType": "contacts.email.added",
"Subject": "contacts.email.added",
"Entity": "Contacts",
"Name": "contacts.email.added",
"Description": "contacts.email.added",
"ProfileId": 49339343,
"Data": {
"EmailAddress": "john.doe@example.com",
"EmailAddressType": "Home",
"IsDefault": false
},
"OriginalEventTime": "2023-11-09T19:44:12.543",
"EventTime": "2023-11-09T19:44:12.543",
"CreateDate": "2023-11-09T19:44:12.450",
"CreatedBy": "My Account Portal"
}
]