Overview

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.

Group Added: The group.added event is triggered when a group is added to a profile or when the group name is modified using the POST Update method where the AllowMerge parameter is set to true. It is accompanied by a group.deactivated event when the group name is modified under the same circumstances (i.e., the old group name is then deactivated).

Plain text

[
    {
        "Topic": "4173-1-2521c7003493478aa79f269f8df4d30c",
        "WebhookProxyRandomValue": "VNxyYU7Y9rZlf1tz135BctADK8MmxDCk6aC2i02n5ByzebjBtioV=",
        "WebhookProxyHashSignature": "seyeOsAiDraj5ZtLdT1mrIqga28GvqvhBl7tbtNS4poOs/NKBH4vDw==",
        "WebhookSignature": "Timestamp:2023-07-12T21:07:28Z Signature:XXb0K2L5I/d6KU+VVeVMXbX+Zm3jHiYtrVFNZluJWJQWu+57HY/V8WrL8nTkaf9uX3oo+Kv0gdNCxC+jcMX/XQ==",
        "EventId": 368741000,
        "EventType": "group.added",
        "Subject": "group.added",
        "Entity": "Groups",
        "SubscriptionId": 1019,
        "Name": "group.added",
        "Description": "group.added",
        "ProfileId": 193282,
        "Data": {
            "GroupName": "Liverpool",
            "GroupType": "Football Fans",
            "IsPrimary": false
        },
        "AppVersion": 1,
        "OriginalEventTime": "2023-07-12T21:06:52.963",
        "EventTime": "2023-07-12T21:06:52.963",
        "CreateDate": "2023-09-07T15:19:47Z",
        "CreatedBy": "My Account Portal"
    }
]

Group Updated: The group.updated is generated when you update the IsPrimary flag on the group. It is also generated when the IsActive flag is set to true, indicating that a previously deactivated profile-group association has been reactivated.

Plain text

{
    "Topic": "58180-1-adcbbde7d88d48c9aeba3ddb4c1c0d3d",
    "WebhookProxyRandomValue": "g/9HObvVlEQQVf5rGoCnQvVy4CW2PMpW91T5TWV01BxSh3oij6tv",
    "WebhookProxyHashSignature": "LhzANL+HjVe7wg1ookE+1c2m1M7ZGV6Q343L008PNdo7PYnhcbotcIohvwvrs+PDo25Xr+ku1HWxC1QWPty0uA==",
    "WebhookSignature": "Timestamp:2024-03-21T19:01:13Z Signature:D6CtHcibZiJ7INPWXgq/YNCbwdmua7/VJnkkRgGT+4CRt/WMab5bCJswi4wowurnLBCJuncYmtw4hmNQBEcRww==",
    "EventId": 127575000,
    "EventType": "group.updated",
    "Subject": "group.updated",
    "Entity": "Groups",
    "SubscriptionId": 55,
    "Name": "group.updated",
    "Description": "group.updated",
    "ProfileId": 193282,
    "Data": {
        "GroupType": "Insurance",
        "GroupName": "HDHP-INSURANCE",
        "IsPrimary": true
    },
    "AppVersion": 1,
    "OriginalEventTime": "2024-03-21T19:01:13.34Z",
    "EventTime": "2024-03-21T19:01:13.34Z",
    "CreateDate": "2024-03-21T19:01:13.31Z",
    "CreatedBy": "My Accounts Portal"
}

Group Deactivated: The group.deactivatedevent is triggered when a group is removed from a profile.

Plain text

{
    "Topic": "58180-1-adcbbde7d88d48c9aeba3ddb4c1c0d3d",
    "WebhookProxyRandomValue": "g/9HObvVlEQQVf5rGoCnQvVy4CW2PMpW91T5TWV01BxSh3oij6tv",
    "WebhookProxyHashSignature": "LhzANL+HjVe7wg1ookE+1c2m1M7ZGV6Q343L008PNdo7PYnhcbotcIohvwvrs+PDo25Xr+ku1HWxC1QWPty0uA==",
    "WebhookSignature": "Timestamp:2024-03-21T19:01:13Z Signature:D6CtHcibZiJ7INPWXgq/YNCbwdmua7/VJnkkRgGT+4CRt/WMab5bCJswi4wowurnLBCJuncYmtw4hmNQBEcRww==",
    "EventId": 127575000,
    "EventType": "group.deactivated",
    "Subject": "group.deactivated",
    "Entity": "Groups",
    "SubscriptionId": 55,
    "Name": "group.deactivated",
    "Description": "group.deactivated",
    "ProfileId": 193282,
    "Data": {
        "GroupType": "Insurance",
        "GroupName": "HDHP-INSURANCE",
        "IsPrimary": true
    },
    "AppVersion": 1,
    "OriginalEventTime": "2024-03-21T19:01:12.34Z",
    "EventTime": "2024-03-21T19:01:13.34Z",
    "CreateDate": "2024-03-21T19:01:13.31Z",
    "CreatedBy": "My Accounts Portal"
}

Sections

Groups

What made this section unhelpful for you?

On this page