Audit Events

Audit Events are generated automatically by Nexmo as the user interacts with either the Nexmo API or the Nexmo Dashboard. Each Audit Event object has a type and associated metadata.

Audit Event types

The following table lists currently supported Audit Event types:

Audit event objects

When you retrieve Audit Events objects via the API they will each have an event_type field, where the event_type will be an entry from the table above. In addition the Audit Event object contains other metadata depending on the type.

For example, for a NUMBER_UPDATED event type the event object would resemble the following:

    {
        "_links": {
          "self": {
            "href": "http://api.nexmo.com/beta/audit/events/aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
          }
        },
        "id": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
        "event_type": "NUMBER_UPDATED",
        "event_type_description": "Number updated",
        "created_at": "2018-05-16T16:34:22",
        "user_email": "yourname@example.com",
        "user_id": 1234567,
        "account_id": "NEXMO_API_KEY",
        "source": "CD",
        "source_ip": "1.2.3.4",
        "source_description": "Customer dashboard",
        "source_country": "GB",
        "context": {
          "country": "GB",
          "msisdn": "447700900000",
          "http": "http://example.com:9000/webhooks/inbound-sms",
          "voice-type": "app",
          "voice-value": "NEXMO_APP_ID"
        }
      }