Event Notifications

Use Event Notifications to receive email or webhook updates when device events occur.

Use this page to identify supported events, understand the payload structure, and request webhook delivery.

Before you start

Confirm that you know:

which device events you want to monitor
whether you need email delivery or webhook delivery
which team or endpoint will receive the notifications

If you are using webhooks, prepare:

the HTTPS endpoint URL
any required authorization headers
the list of event types you want to subscribe to

What Event Notifications support

Use Event Notifications to:

subscribe to operational device events
route events to email or webhook destinations
integrate device events with external monitoring or workflow tools

Choose a delivery method

Email

Use email when a team needs human-readable updates for follow-up work.

Webhook

Use webhooks when another system needs to receive and process events automatically.

Webhook delivery requires Verifone support to complete the setup.

Common event categories

Most subscriptions fall into these categories:

Device status and lifecycle — activation, status change, deletion, missing device
Device changes — hierarchy change, group change, parameter change, reboot
Platform and software events — software version updates, hierarchy creation, group deletion

Use the full event catalog when you need exact event names and payload fields.

Full event catalog

Events are the topics a notification listens to. A notification is sent when the selected event occurs.

View supported event types

Event Type

Description

Details

EstateDeviceStatusUpdated

Status of Device is Changed

Any change in the status of the device.

See more details in the Device Status section.

EstateDeviceDeleted

Device is Deleted

The Device is deleted temporarily (SOFT) or permanently (HARD).

In the case of a SOFT deletion, the device is no longer displayed in Device Management. The data can be retrieved by undeleting the device.

EstateDeviceSwapped

Device is Swapped

An existing device at the merchant is swapped with a new device.

EstateDeviceActivated

New Device is Activated

A new device is registered and is actively managed in Device Management.

EstateDeviceBoarded

New Device is Boarded

A new device is configured in Device Management.

The physical device is not yet registered.

EstateDevicePaired

Device is Paired

A new device with a specified Serial Number is paired with a device configured in Device Management.

The new device is configured in Device Management and identified by Device ID.
Once the physical device arrives at the merchant store, the merchant or operator enters the assigned Device ID and starts registration.
The device registers with Device Management.
The physical device identified by Serial Number is paired with the configured device record.

EstateDeviceParametersUpdated

Device Parameters are Updated

Parameters of the device are changed.

Parameters can be added, updated, or deleted in the portal, through APIs, or on the physical device.

EstateDeviceRebooted

Device has Rebooted

The device has rebooted.

rebootType indicates the source of the reboot:

PCI - reboot triggered automatically for PCI compliance
AGENT - reboot triggered by the agent
SYSTEM - reboot triggered by the operating system

EstateDeviceTampered

Device is Tampered

The security of the device is compromised. This can be a physical tamper or a soft tamper, such as invalid security keys or temperature outside the normal range.

EMVVersionMismatch

EMV Version Mismatch

The EMV version of the payment device and PIN pad do not match.

EstateDeviceHierarchyUpdated

Device Hierarchy is Changed

The device is moved to a different hierarchy.

EstateDeviceGroupUpdated

Device Group is Changed

The device is added or moved to one or more groups.

The device is removed from one or more groups.

SoftwareVersionUpdated

New software version is available

An existing software version is not available anymore

A new software package is uploaded and becomes available for use.

An existing software package is deleted.

HierarchyUpdated

New hierarchy is added

A new hierarchy is added.

GroupDeleted

Device Group is deleted

The device group is deleted.

EstateDeletedDeviceContacting

Deleted Device is trying to communicate with Device Management

Deleted devices are expected to be out of service and no longer used for transactions.

Any communication from a deleted device can indicate malicious activity.

EstateDeviceMissing

Device missing

The device has not communicated with the server for an extended period.

For example, if the device sends heartbeats every 15 minutes, the event can be raised after 30 minutes without communication.

EstateDeviceUpdated

Device updated

One or more device attributes changed.

Device IP Address
Location

Understand the payload structure

Every event payload contains:

standard attributes shared across events
event-specific data in the content object

Standard attributes

Use these fields to identify the event source, type, and affected object.

View standard payload attributes

Attribute

Description

eventId

Unique identifier of the event for audit and logging.

eventDateTime

Date and time when the event occurred, usually at local time.

itemId

Unique identifier of the object related to the event.

This can be a JSON object when the item uses a composite key. If the item has a single key, that key is used directly.

entityUid

Unique identifier of the entity for which the event is generated.

eoEntityUid

Unique identifier of the owner, customer, or merchant of the event.

source

Name of the source application sending the event.

component

Source component sending the event.

received

Date and time, in UTC, when the server received the event notification.

eventType

String naming the event type.

objectType

`DeviceEvent` or `StandardEvent`.

content

Associated event data. This field is optional and varies by event type.

userUid

Unique identifier of the user that triggered the event, when relevant.

deviceType

Device model.

estateManagementId

Terminal device ID.

serialNumber

Device serial number.

estateManagementHierarchyId

Hierarchy ID of the terminal in Device Management.

Register for webhook events

To request webhook delivery:

Open a support ticket with Verifone support.
Provide your organization name.
Provide the list of event types you want to receive.
Provide the HTTPS endpoint URL for delivery.
Provide any required authorization headers.
Complete the setup with Verifone support.
Verify event delivery and payload handling in your receiving system.

Event payload reference

Use this section when you need field-level detail or sample payloads for implementation.

View event parameters and sample payloads

Event

Parameter

Type

Description

Sample payload

Status of Device is Changed

newStatus

String

New status of the device

{
    "content": {
        "newStatus": "Active",
        "oldStatus": "Inactive"
    },
    "eventType": "EstateDeviceStatusUpdated",
    "objectType": "DeviceEvent"
}

oldStatus

String

Old status of the device

Device Is Deleted

Type

String

Indicates the mode of device deletion:

SOFT - Soft deleted
HARD - Permanently deleted

{
    "content": {
        "type": "SOFT",
        "certificates": [
            {
                "certificate": "-----BEGIN CERTIFICATE-----\nMIIECjCCAvKgAwIBAg+O0a7haOHtNAoRS0GTNLsick982I\n-----END CERTIFICATE-----\n"
            },
            {
                "certificate": "-----BEGIN CERTIFICATE-----\nMIIECjCCAvKgAwIBAg+O0a7haOHtNAoRS0GTNLsick982I\n-----END CERTIFICATE-----\n"
            }
        ]
    },
    "eventType": "EstateDeviceDeleted",
    "objectType": "DeviceEvent"
}

Device is Swapped

newDeviceModel

String

Device model name of the new device

{ 
    "content": { 
        "oldSerialNumber": "123-459-789", 
        "oldDeviceModel": "CM5P", 
        "newSerialNumber": "111-111-111", 
        "newDeviceModel": "CM5P" 
    }, 
    "eventType": "EstateDeviceSwapped", 
    "objectType": "DeviceEvent" 
}

newSerialNumber

String

Serial number of the new device

oldDeviceModel

String

Device model name of the device being replaced

oldSerialNumber

String

Serial number of the device being replaced

New Device is Activated

hierarchy

String

Hierarchy path of the device

{ 
    "content": { 
        "hierarchy": "Root >> Region >> City >> Store", 
        "newStatus": "Active", 
        "oldStatus": "PendingRegistration" 
    }, 
    "eventType": "EstateDeviceActivated", 
    "objectType": "DeviceEvent" 
}

newStatus

String

New status of device

oldStatus

String

Old status of device

New Device is boarded

hierarchy

String

Hierarchy path of the device

{ 
    "content": { 
        "hierarchy": "Root >> Region >> City >> Store " 
    }, 
    "eventType": " EstateDeviceBoarded", 
    "objectType": "DeviceEvent" 
}

Device is paired

serialNumber

String

Serial number of the device

{ 
    "content": { 
        "serialNumber": "111-111-111", 
        "deviceId": "111-111-111", 
        "deviceModel": "CM5P" 
    }, 
    "eventType": "EstateDevicePaired", 
    "objectType": "DeviceEvent" 
}

deviceId

String

Device ID of the device

deviceModel

String

Model name of the device

Device Parameters are updated

applicationName

String

Application name

{ 
    "content": { 
        "applicationVersion": "5.330.40", 
        "applicationName": "com.android.settings", 
        "parameters": { 
            "value": { 
                "Main": [ 
                    { 
                        "tip": "false" 
                    } 
                ] 
            }, 
            "operation": "update" 
        } 
    }, 
    "eventType": "EstateDeviceParametersUpdated", 
    "objectType": "DeviceEvent" 
}

applicationVersion

String

Version of the application

parameters

String

Modified parameters of the application.

For more details refer to the Device parameters updated sample payload section.

Device has rebooted

rebootType

String

Possible values:

PCI - Device is rebooted automatically by the system as part of PCI compliance.
AGENT - Device is rebooted by the DMS Agent.
SYSTEM - Device is rebooted automatically by the Operating system

{ 
    "content": {"rebootType":"SYSTEM"}, 
    "eventType": "EstateDeviceRebooted", 
    "objectType":"DeviceEvent" 
}

Device is tampered

N/A

{ 
    "content": null, 
    "eventType": "EstateDeviceTampered", 
    "objectType": "DeviceEvent" 
}

EMV Version mismatch

N/A

{ 
    "content": null, 
    "eventType": "EMVVersionMismatch", 
    "objectType": "DeviceEvent" 
}

Device Hierarchy is changed

N/A

{ 
    "content": null, 
    "eventType": "EstateDeviceHierarchyUpdated", 
    "objectType": "DeviceEvent" 
}

Device Group is changed

groupId

String

Comma separated list of all the Group IDs that the Device belongs to after the change.

{ 
    "content": { 
        "groupId":"10,11" 
    }, 
    "eventType": "EstateDeviceGroupUpdated", 
    "objectType": "DeviceEvent" 
}

New software version available

An existing software version no more available

applicationName

String

Name of the package

{ 
    "content": { 
        "version": "3.2.16-653", 
        "deviceModel": "", 
        "softwareType": "EngageAgent", 
        "status": "Updated", 
        "osType": "VOS2", 
        "applicationName": "" 
    }, 
    "eventType": "SoftwareVersionUpdated", 
    "objectType": "StandardEvent" 
}

version

String

Package version

deviceModel

String

Comma separated list of device models compatible with the Package.

softwareType

String

Software type of the package, e.g.: Android, Engage, etc.

status

String

status = Updated - a new package is added

status = Deleted - an existing package is removed.

osType

String

Package OS type, e.g., VX, VOS, VOS2, VOS3.

New hierarchy is added

parentHierarchyId

String

Parent Hierarchy Id of the hierarchy

{ 
    "content": { 
        "parentHierarchyId": "6465", 
        "hierarchyId": "6466" 
    }, 
    "eventType": "HierarchyUpdated", 
    "objectType": "StandardEvent" 
}

hierarchyId

String

Hierarchy Id of the newly added hierarchy

Device Group is deleted

groupId

String

Group Id of the deleted Group

{ 
    "content": { 
        "groupId":"10" 
    }, 
    "eventType": "GroupDeleted", 
    "objectType": "StandardEvent" 
}

Deleted Device is trying to communicate with DMS

N/A

{ 
    "content": null, 
    "eventType": "EstateDeletedDeviceContacting", 
    "objectType": "DeviceEvent" 
}

Device missing

N/A

{ 
    "content": null, 
    "eventType": "EstateDeviceMissing", 
    "objectType": "DeviceEvent" 
}

Device updated

delta

Object

IP Address Change:

It's an object that has details of IP Address.

{
"content": {
"delta": {
"ipAddress": {
"old": "xx.xx.xx.xx"
"new": "yy.yy.yy.yy"
},
"location": {
"old": "North Kennedy Bvld",
"new": "East Kennedy Bvld"
}
}
},
"eventType": "EstateDeviceUpdated",
"objectType": "DeviceEvent"
}

delta

Object

Location Change:

It's an object that has details of location.

References

Device status

These values are relevant to device status change events.

The device status can have the following values:

Pending Registration — the device is not yet registered with the server. Pre-boarded devices are placed in this state by default.
Pending Hierarchy Assignment — the device is not yet assigned successfully to a hierarchy after registration.
Active — the device is registered, assigned, and ready for use.
Inactive — the device exists in the estate but is not currently active.
Deleted — the device is soft deleted and can return to its previous state if undeleted. Permanently deleted devices cannot be undeleted.

Device parameters updated sample payload

Use these operations to add, update, or delete parameters:

parameters > Operation = add — adds parameters. value contains the new parameters.
parameters > Operation = update — updates parameters. value contains the updated parameters.
parameters > Operation = delete — deletes parameters. value contains the deleted parameters.

{ 
   "CONTENT":{ 
      "applicationName":"com.verifone.settings", 
      "applicationVersion":"1.0", 
      "parameters":[ 
         { 
            "operation":"add", 
            "value":{              
                "Merchant":[ 
                    { 
                        "MerchantId":"1", 
                        "MerchantSurcharge":[ 
                            { 
                                "MaxSurchargeableAmount":"0", 
                                "SurchargeValue":"0", 
                                "MaxSurchargeAdjAmount":"0", 
                                "SurchargeValueInternational":"0" 
                            } 
                        ] 
                    } 
                ]         
            }            
         }, 
         { 
            "operation":"update", 
            "value":{ 
               "Terminal":[ 
                  { 

                     "ChipMaxTriesBeforeFallback":"3", 
                     "MsrMaxTriesBeforeFallback":"3", 
                     "SAFEnabled":"1", 
                     "SettlementContinueOnSAFQueueFlushFailure":"0", 
                     "EmvCtlsTerm":[ 
                        { 

                           "TerminalType_9F35":"", 
                           "ToneVolume_DF62":"" 
                        } 
                     ] 
                  } 
               ] 
            } 
         }, 
         { 

            "operation":"delete", 
            "value":{ 
               "Acquirer":[ 
                  { 
                     "AcquirerId":"1" 
                  }, 
                  { 
                     "AcquirerId":"2" 
                  } 
               ] 
            } 
         } 
      ] 
   } 
}

Result

Event Notifications route device events to the people or systems that need to respond.

Next steps

Notifications — review in-product notification updates
Alerts and notifications — understand the broader event and alert model
Device life cycle — understand status values used in event payloads

PreviousAlert administration NextTenants

Last updated 4 hours ago

Was this helpful?