Profile events
client.add
A profile was added to the database.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
The event doesn’t include information about profile data such as email address or custom parameters that were sent when creating the profile.
client.identify
A profile was updated or created with information that changed its status to “recognized”. By default, this happens when an email address is provided.
Default retention: 30 days
Recommended retention: infinite
The retention of this event affects the ability to debug profiles.
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| string | example@synerise.com |
Email address of the profile |
client.register
A profile was registered successfully. This event is only generated for Registration-as-a-Service.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| firstname | string | John |
First name of the profile |
| firstname | string | Doe |
Last name of the profile |
| applicationName | string | testApp |
Name of the application where the profile registered |
| string | example@synerise.com |
Email address of the profile | |
| firstname | string | Little teapot |
Custom identifier of the profile |
client.updateData
A profile’s data was updated. Legacy event, available as profile.updated in analytics. Includes the same data as profile.updated.
Default retention: 30 days
profile.updated
A profile was updated.
Default retention: 90 days
Retention guidelines:
Lowering the retention of this event affects:
- In Automations and Communication: filters based on recent profile updates.
- In debugging:
- Investigating marketing agreement and attribute updates.
- Investigating what forms were submitted and which data they changed.
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| profile.<changed_attribute> | depends on attribute | Joe |
Each attribute changed or added in the operation that created this event is saved as a profile.<changed_attribute> parameter. The value of the parameter is the new value of the profile attribute. For example, if the city attribute changed in the profile, the name of the event parameter with the new value is profile.city. |
client.addTag
A tag was assigned to a profile.
Default retention: 30 days
Recommended retention: infinite
The retention of this event affects analytics (such as client base growth) and troubleshooting (tracking how the profile was created).
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| id | integer | 1856 |
Unique ID of the tag |
| name | string | clubmember |
Name of the tag |
client.removeTag
A tag was removed from a profile.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| id | integer | 1856 |
Unique ID of the tag |
| name | string | clubmember |
Name of the tag |
client.merge
Two or more profiles were merged into one.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| previouscustomers | array of objects | [{"anonymousType":"CUSTOM_ID","email":"default_unique_a95d2fc9-9b94-4d1c-a272-a94760f622a3@anonymous.invalid","id":5290506224},{"anonymousType":"NONE","email":"littleteapot@example.com","id":5290506228}] |
Information about the profiles that were merged into this profile |
profile.segmentationMembershipUpdated
A membership attribute has been created or updated.
Default retention: 30 days
| Parameter | Type | Example | Description |
|---|---|---|---|
| Base parameters | various | n/a | Parameters that may exist in all events |
| valueSet | boolean | true |
The membership status value: - true: a profile joined the segmentation;- false: a profile left the segmentation. |
| groupId | string | f3019938-22fa-41a8-91bd-2ccdege60e34 |
The unique identifier of the workspace group for which the segmentation export is configured (on the organization level). |
| group | string | Multribrand group name |
The name of the workspace group for which the segmentation export is configured (on the organization level). |
| segmentationId | string | 2e57b401-a7b9-401b-8cae-49f4fc8a0242 |
The unique identifier of the segmentation. |
| attributeName | string | Workspace name_mbr_segmentation_loyal_2e57b401-a7b9-401b-8cae-49f4fc8a0242 |
The name of the membership attribute that was updated as a result of the membership change. |
| processId | string | a08bedc5-4aa3-53b5-85d2-0f1b2299d676 |
The ID of the primary organization-level process responsible for managing segmentation assignments. |
| jobId | string | d757b0d8-d649-4099-a3fb-6709f82d5c27 |
The unique identifier of the materialization job execution. |
| source | string | internal |
Indicates the segmentation origin: - internal: from the current workspace; - external: from a different workspace. |
