Entity Update Event

Edit on GitHubView Markdown
On this page

Entity Update

Available since 1.69.0

This event is generated when an entity is updated. The JSON includes the Entity that was updated.

Event type

entity.update

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 transactional. The final state of the operation which caused the webhook is not persisted to FusionAuth until after the webhook finishes; learn more

Event Body

event.createInstant
  • Type: Long

The instant that the event was generated.

event.entity
  • Type: Object

The entity that has been updated. See the Entity API for property definitions and example JSON.

event.id
  • Type: UUID

The unique Id of the event.

event.info.data
  • Type: Object

An object that can hold any information about the event that should be persisted.

event.info.deviceDescription
  • Type: String

The description of the device associated with the event.

event.info.deviceName
  • Type: String

The device name associated with the event.

event.info.deviceType
  • Type: String

The type of device associated with the event.

event.info.ipAddress
  • Type: String

The source IP address of the event.

event.info.location.city
  • Type: String

The city where the event originated.

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

event.info.location.country
  • Type: String

The country where the event originated.

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

event.info.location.latitude
  • Type: Double

The latitude where the event originated.

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

event.info.location.longitude
  • Type: Double

The longitude where the event originated.

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

event.info.location.region
  • Type: String

The geographic location where the event originated.

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

event.info.location.zipcode
  • Type: String

The zip code where the event originated.

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

event.info.os
  • Type: String

The operating system associated with the event.

event.info.userAgent
  • Type: String

The user agent associated with the event.

event.linkedObjectId
  • Type: UUID

The Id of the entity impacted by this event.

event.original
  • Type: Object

The original entity, before update. See the Entity API for property definitions and example JSON.

event.tenantId
  • Type: UUID

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

event.type
  • Type: String

The event type, this value will always be {eventType}.

Example Event JSON
{
  "event": {
    "createInstant": 1660777395126,
    "entity": {
      "clientId": "092dbded-30af-4149-9c61-b578f2c72f59",
      "data": {},
      "id": "8174f72f-5ecd-4eae-8de8-7fef597b3473",
      "insertInstant": 1660777395126,
      "lastUpdateInstant": 1660777396676,
      "name": "Erlich's Thermostat (modified)",
      "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1",
      "type": {
        "data": {},
        "id": "4838d96a-4e7b-42c6-a4a1-ebc64952e1c8",
        "insertInstant": 1518962408732,
        "jwtConfiguration": {
          "enabled": false,
          "timeToLiveInSeconds": 0
        },
        "lastUpdateInstant": 1518962408732,
        "name": "Thermostat",
        "permissions": [
          {
            "data": {},
            "description": "Hold the temperature on the Thermostat",
            "id": "ce485a91-906f-4615-af75-81d37dc71e90",
            "insertInstant": 1518962408732,
            "isDefault": false,
            "lastUpdateInstant": 1518962408732,
            "name": "HOLD_TEMPERATURE"
          },
          {
            "data": {},
            "description": "Set the temperature on the Thermostat",
            "id": "f65f7859-2eb0-4dc0-a3ca-b3fdc5c11e64",
            "insertInstant": 1518962408732,
            "isDefault": true,
            "lastUpdateInstant": 1518962408732,
            "name": "SET_TEMPERATURE"
          }
        ]
      }
    },
    "id": "2ed2a35c-eff5-41b4-822d-ba1b85d814c4",
    "info": {
      "ipAddress": "127.0.0.1",
      "userAgent": "Restify (https://github.com/inversoft/restify)"
    },
    "original": {
      "clientId": "092dbded-30af-4149-9c61-b578f2c72f59",
      "data": {},
      "id": "8174f72f-5ecd-4eae-8de8-7fef597b3473",
      "insertInstant": 1660777395126,
      "lastUpdateInstant": 1660777395156,
      "name": "Erlich's Thermostat",
      "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1",
      "type": {
        "data": {},
        "id": "4838d96a-4e7b-42c6-a4a1-ebc64952e1c8",
        "insertInstant": 1518962408732,
        "jwtConfiguration": {
          "enabled": false,
          "timeToLiveInSeconds": 0
        },
        "lastUpdateInstant": 1518962408732,
        "name": "Thermostat",
        "permissions": [
          {
            "data": {},
            "description": "Hold the temperature on the Thermostat",
            "id": "ce485a91-906f-4615-af75-81d37dc71e90",
            "insertInstant": 1518962408732,
            "isDefault": false,
            "lastUpdateInstant": 1518962408732,
            "name": "HOLD_TEMPERATURE"
          },
          {
            "data": {},
            "description": "Set the temperature on the Thermostat",
            "id": "f65f7859-2eb0-4dc0-a3ca-b3fdc5c11e64",
            "insertInstant": 1518962408732,
            "isDefault": true,
            "lastUpdateInstant": 1518962408732,
            "name": "SET_TEMPERATURE"
          }
        ]
      }
    },
    "tenantId": "f84cfebc-d68f-4b8c-9014-f9afa6ccc3e1",
    "type": "entity.update"
  }
}

Related

Extend

Entity Create Event

Learn about the Entity Create event.

entity webhookfusionauth entitywebhook event
Extend

Entity Create Complete Event

Learn about the Entity Create Complete event.

entity webhookfusionauth entitywebhook event
Extend

Entity Delete Event

Learn about the Entity Delete event.

entity webhookfusionauth entitywebhook event
Extend

Entity Delete Complete Event

Learn about the Entity Delete Complete event.

entity webhookfusionauth entitywebhook event