Overview

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 Added: The preference.added event is triggered any time a new preference gets added to a profile.

Plain text

[
  {
    "Topic": "57167-1-77e37ab924ad4350bb994d3dc7fe7a9e",
    "WebhookProxyRandomValue": "I5Fd7XrQnfFVeagC46is/feg33HzuOL3y9I4Z8827R4x0Q==",
    "WebhookProxyHashSignature": "ylvRjgE2A2NSTzIgcmxhxKMa0vE9fzxOcswcz1HqR6ZpiVEKUXiyXhbO2bJRxvWYLaYeNaHypr+Yyw==",
    "WebhookSignature": "Timestamp:2025-10-25T01:17:24Z Signature:ljmRMfWwggsxNdat0NZdh2moKKL55403957WkB1CacLvybHOEWNTvUVqDnysuFGKQu6Ks50z0aE0r1v0g==",
    "EventId": 561377000,
    "EventType": "preference.added",
    "Subject": "preference.added",
    "Entity": "Preferences",
    "SubscriptionId": 41,
    "Name": "preference.added",
    "Description": "preference.added",
    "ProfileId": 3521,
    "Data": {
      "MissingRequiredConsents": false,
      "FilterID": "EM_Financial Planning",
      "PreferenceType": "Opt-In",
      "FilterName": "Financial Planning Webinars",
      "TypeName": "Home",
      "LastModifiedDate": "2025-10-25T01:17:23.060Z",
      "CustomerDate": "2025-10-25T01:17:21.000Z",
      "SourceId": "Default",
      "Frequency": "Weekly",
      "Channel": "Email",
      "ProgramId": "Finanical Planning",
      "ProgramName": "Finanical Planning",
      "EmailAddress": "john.doe@example.com",
      "IsDefault": false,
      "ReasonCode": "",
      "MatchType": "Expressed",
      "ExpirationDate": "2026-10-25T01:17:21",
      "PreferenceStatus": "Active"
    },
    "AppVersion": 1,
    "EventTime": "2025-10-25T01:17:24.180Z",
    "OriginalEventTime": "2025-10-25T01:17:23.097Z",
    "CreateDate": "2025-10-25T01:17:23.060Z",
    "CreatedBy": "Mobile App"
  }
]

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.

Plain text

[
    {
        "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.

Plain text

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

Sections

Preferences

What made this section unhelpful for you?

On this page