Resources
🤖 For AI agents: The complete documentation index is available at /docs/llms.txt. A markdown version of this page is available at /docs/extend/events-and-webhooks/events/group/group-delete-complete.md.

Delete Complete

Edit on GitHub
View Markdown

Group Delete Complete

version
This event has been available since 1.38.0

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

Event type
group.delete.create

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.

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 deleted. 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: To use event location data, you'll need an Enterprise plan.

event.info.location.country String

The country where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.latitude Double

The latitude where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.longitude Double

The longitude where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.region String

The geographic location where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.location.zipcode String

The zip code where the event originated.

Note: To use event location data, you'll need an Enterprise plan.

event.info.os String

The operating system associated with the event.

event.info.userAgent String

The user agent associated with the event.

event.linkedObjectId UUID Available since 1.53.0

The Id of the group impacted by this event.

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.delete.create.

Example Event JSON

{
  "event": {
    "createInstant": 1660777395126,
    "group": {
      "data": {},
      "id": "89450cd0-24a9-401d-a6ad-4116de45b8e2",
      "insertInstant": 1660777395126,
      "lastUpdateInstant": 1660777395156,
      "name": "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)"
    },
    "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1",
    "type": "group.delete.complete"
  }
}