Skip to main content

​
Event types and tags

Events are generated when specific actions happen in your fleet, and are tracked using Event tags that are attached to each event. Those event tags define what the event was, and which SIMs it happened for. System-generated event tags begin and end with underscores, for example _DATALIMIT_ or _DEVICE_123456_, and are reserved for system use. The following event types can be monitored and alerted on:
Event nameEvent tagDescription
Data limit reached_DATALIMIT_A SIM reached a data usage limit and was paused.
Data warning threshold reached_DATAWARNING_A SIM reached a data warning threshold.
IMEI change_IMEI_CHANGE_The last available IMEI for a SIM changed between data sessions, generally meaning the SIM has been moved to a new device. More information is in the message body.
IMEI TAC change_IMEI_TAC_CHANGE_The last available IMEI TAC prefix for a SIM changed between data sessions, inferring that new modem hardware is being used. This event is always accompanied by an IMEI change event.
First IMEI recognized_IMEI_FIRST_A SIM was first connected to the network and an IMEI was detected. More information is in the message body.
SMS received_SMS_DT_An SMS message was received by a SIM.
SMS sent_SMS_DO_An SMS message was sent from a SIM.
SMS delivered_SMS_DT_DELIVERED_An SMS message was delivered to a SIM successfully.
TCP/UDP message received_API_DT_A TCP/UDP message was received by a SIM.
API responded to an event_API_RESP_When a device responds to a message sent using the cloud-to-device API or Dashboard features, the response contains this topic.
Conductor configuration change_EUICC_CONFIGURE_SIM_Conductor completed orchestration of a SIM or profile configuration change. The message body contains the details of the configuration change including SIM information, configuration changes to make, and the status of the operation.
Some legacy event tags may still be present in old events such as _SOCKETAPI_, _JSONSTRING_, _SIMPLESTRING_, _SMS_, _SMSOVERIP_, _RESTAPI_, but are no longer supported.

​
Generic event tags

Each event has tags applied that give additional context about which SIMs were affected by the event. These tags are used to identify which SIMs an event was created for. You can create alerts using these event tags to receive notifications for specific SIMs or groups of tagged SIMs that you want to monitor. Only one of these identifying tags can be added to an alert, however, so if you want to monitor multiple SIMs with one alert then you should tag those SIMs and create an alert that monitors that tag (e.g. _TAG_123456_).
Event tagDescription
_DEVICE_XXX_The event was triggered for a specific SIM/device (for example, _DEVICE_1234_).
_TAG_XXX_Added for each tag that a SIM/device has at the time the event is created.

​
Event message fields

Each event also has a default message that is sent with the event to notification recipients. The default message body and content includes the following default fields: 
{
  "received": "2016-09-27T18:53:09.302915",
  "authtype": "psk",
  "tags": ["TOPIC1", "_DEVICE_12345_"],
  "device": { "id": 5678, "name": "My Device" },
  "errorcode": 0,
  "source": "abcd",
  "timestamp": "0",
  "data": "SGVsbG8sIHdvcmxkIQo="
}

​
Field reference

  • received: ISO8601-formatted UTC timestamp when the event was received by the Hologram Cloud.
  • tags: Array of topics that the message belongs to.
  • device.name: Human-readable name of the device, as specified in the Hologram Dashboard.
  • device.id: Integer device ID.
  • data: Base64-encoded representation of the data payload.
  • authtype: Method by which the message sender authenticated with the Hologram Cloud.
  • errorcode: 0 for messages processed successfully.
  • source: Source ID from the credentials used to send the event. Some data sources use a different authentication method so this field may not always be present.

​
Referencing field contents

You can reference the contents of the default message fields in your alert notification messages using variables, as outlined in the Event monitoring and alerting overview guide. The data field is base64-encoded. If the message body is a string or JSON object, the decoded content can be referenced using <<decdata>>.