Extra Payload Attributes

These attributes make up the extra payload for the UserGroup webhook resource for the following events: Create / Update / Delete

Create Attributes

ATTRIBUTE
members object
members.added array of objects
members.added.isRecursive boolean
members.added.entityId string
members.added.entityType string

Update Attributes

ATTRIBUTE
members object
members.updated array of objects
members.updated.isRecursive boolean
members.updated.entityId string
members.updated.entityType string

Delete Attributes

ATTRIBUTE
members object
members.deleted array of objects
members.deleted.isRecursive boolean
members.deleted.entityId string
members.deleted.entityType string

Webhook Payload Notification Samples

{
  "eventId": "2269cfce-1d4b-43d6-94c6-439545e6cdbd",
  "eventTime": "2024-11-20T05:06:13.076Z",
  "eventType": "create",
  "meta": {
    "userId": "admin",
    "resourceType": "userGroup",
    "resourceId": "51145",
    "instanceId": "be11105680j",
    "resourceRef": "/encompass/v3/settings/userGroups/51145",
    "payload": {
      "members": {
        "added": [
          {
            "isRecursive": false,
            "entityId": "37",
            "entityType": "Organization"
          }
        ]
      }
    }
  }
}

{
  "eventId": "7fd80cbb-421d-4485-9b43-256e6764be7f",
  "eventTime": "2024-11-20T05:06:23.793Z",
  "eventType": "update",
  "meta": {
    "userId": "admin",
    "resourceType": "userGroup",
    "resourceId": "51145",
    "instanceId": "be11105680j",
    "resourceRef": "/encompass/v3/settings/userGroups/51145",
    "payload": {
      "members": {
        "updated": [
          {
            "isRecursive": false,
            "entityId": "37",
            "entityType": "Organization"
          }
        ]
      }
    }
  }
}

{
  "eventId": "d48bf7b1-fefa-4ac4-a03a-0cd0c82ab75c",
  "eventTime": "2024-11-20T05:06:43.386Z",
  "eventType": "delete",
  "meta": {
    "userId": "admin",
    "resourceType": "userGroup",
    "resourceId": "51145",
    "instanceId": "be11105680j",
    "resourceRef": "/encompass/v3/settings/userGroups/51145",
    "payload": {
      "members": {
        "deleted": [
          {
            "isRecursive": false,
            "entityId": "37",
            "entityType": "Organization"
          }
        ]
      }
    }
  }
}