Logo/Docs

Group Update Complete

Group Update Complete

This event has been available since 1.38.0

This event is generated when a group is updated. The JSON includes the Group that was updated.

Event type
group.update.complete

Event Scope

This is a tenant scoped event.

It can be sent to all tenants or to one or more specified tenants. However, those tenants will not be sent events for other tenants, but only events related to themselves.

Prior to version 1.37.0 this was a tenant scoped event. This event will be sent to all tenants that are listening, but will contain a tenantId to allow for filtering.

In version 1.37.0 and later this is also a tenant scoped event. It can be sent to all tenants or to one or more specified tenants. However, those tenants will not be sent events for other tenants, but only events related to themselves.

Transaction Compatibility

This event is non-transactional. The operation will succeed regardless of the webhook response status code.

Event Body

event.createInstant[Long]

The instant that the event was generated.

event.group[Object]

The group that has been updated. See the Groups API for property definitions and example JSON.

event.id[UUID]

The unique Id of the event.

event.info.data[Object]
An object that can hold any information about the event that should be persisted.
event.info.deviceDescription[String]
The description of the device associated with the event.
event.info.deviceName[String]
The device name associated with the event.
event.info.deviceType[String]
The type of device associated with the event.
event.info.ipAddress[String]
The source IP address of the event.
event.info.location.city[String]
The city where the event originated. Note: A paid plan is required to utilize event info location.
event.info.location.country[String]
The country where the event originated. Note: A paid plan is required to utilize event info location.
event.info.location.latitude[Double]
The latitude where the event originated. Note: A paid plan is required to utilize event info location.
event.info.location.longitude[Double]
The longitude where the event originated. Note: A paid plan is required to utilize event info location.
event.info.location.region[String]
The geographic location where the event originated. Note: A paid plan is required to utilize event info location.
event.info.location.zipcode[String]
The zip code where the event originated. Note: A paid plan is required to utilize event info location.
event.info.os[String]
The operating system associated with the event.
event.info.userAgent[String]
The user agent associated with the event.
event.original[Object]

The original group, before update. See the Groups API for property definitions and example JSON.

event.tenantId[UUID]

The unique tenant identifier. This value may not be returned if not applicable.

event.type[String]

The event type, this value will always be group.update.complete.

Example Event JSON

{
  "event": {
    "createInstant": 1660777395126,
    "group": {
      "data": {},
      "id": "89450cd0-24a9-401d-a6ad-4116de45b8e2",
      "insertInstant": 1660777395126,
      "lastUpdateInstant": 1660777396676,
      "name": "Pied Piper Employees",
      "roles": {},
      "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1"
    },
    "id": "2ed2a35c-eff5-41b4-822d-ba1b85d814c4",
    "info": {
      "ipAddress": "127.0.0.1",
      "userAgent": "Restify (https://github.com/inversoft/restify)"
    },
    "original": {
      "data": {},
      "id": "89450cd0-24a9-401d-a6ad-4116de45b8e2",
      "insertInstant": 1660777395126,
      "lastUpdateInstant": 1660777395156,
      "name": "Employees",
      "roles": {},
      "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1"
    },
    "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1",
    "type": "group.update.complete"
  }
}