Event Payload Samples
The Webhook Payload Samples section provides 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.
The following events include a PreviousData collection, which contains the information as it existed before the event occurred. The current or updated information is available in the main Data collection.
- contacts.phone.updated
- contacts.email.updated
- contacts.address.updated
- contacts.alternateid.updated
- contacts.customertype.updated
- standardfield.defaultlocale.updated
- standardfield.firstname.updated
- standardfield.middlename.updated
- standardfield.lastname.updated
- customfield.updated
By default, the webhook event payload includes a static text for Name and Description fields for each event type. Presently, these cannot be programmatically updated, and requests for updates specific to each event type must be made through our support team.
If your webhook subscription is set up with an AlternateIdType, the ProfileId in the event payload will be replaced with the AlternateId associated with the AlternateIdType specified in your webhook subscription request.
What made this section unhelpful for you?
On this page
- Event Payload Samples