Docs

Event types

The following event types are only available for MNOs and resellers using emnify.

All other event types are also available for MNO and reseller accounts. You can find those events on the Event types page of the platform documentation.

Authentication

Password reset requested

Reset password email is requested for a specific email address.

1{
2  "timestamp": "2021-12-20T00:00:43.000Z",
3  "alert": false,
4  "description": "Password reset requested",
5  "id": 213045251604518,
6  "event_type": {
7    "id": 37,
8    "description": "Password reset requested"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 0,
16    "description": "Info"
17  },
18  "organisation": {
19    "id": 654321,
20    "name": "Sample Corp"
21  },
22  "user": {
23    "id": 123456,
24    "name": "Sample User",
25    "username": "abc@cde.com"
26  },
27  "detail": {
28    "id": 123456,
29    "username": "abc@cde.com",
30    "name": "Sample User",
31    "organisationId": 654321,
32    "activationKey": "JWT for resetting the password",
33    "sourceIp": "192.168.1.1",
34    "userAgent": "Chrome"
35  }
36}

User verification requested

User signed up or requested another verification email.

This event is only needed when customers use self-signup. Manually invited users already verified their email.

1{
2  "timestamp": "2021-12-20T00:08:10.000Z",
3  "alert": false,
4  "description": "Verification requested for user 'pooled.15mb-americas@m2mtelecom.com'",
5  "id": 213052601483453,
6  "event_type": {
7    "id": 40,
8    "description": "User verification requested"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 0,
16    "description": "Info"
17  },
18  "organisation": {
19    "id": 2,
20    "name": "emnify GmbH"
21  },
22  "user": {
23    "id": 123456,
24    "name": "Sample User",
25    "username": "abc@cde.com"
26  },
27  "detail": {
28    "token": "JWT token to add to the link in the email for verification"
29  }
30}

Organization and billing

IDDescription
17Self-Signup
36User invited

Self-Signup

Customer used self-signup to create their account.

1{
2  "timestamp": "2021-11-04T12:53:47.000Z",
3  "alert": false,
4  "description": "John Doe (john.doe@company.com) has signed up with organisation name Test Org 3.",
5  "id": 148688626139183,
6  "event_type": {
7      "id": 17,
8      "description": "Self-Signup"
9  },
10  "event_source": {
11      "id": 2,
12      "description": "API"
13  },
14  "event_severity": {
15      "id": 0,
16      "description": "Info"
17  },
18  "organisation": {
19      "id": 14210,
20      "name": "Test Org 3"
21  },
22  "user": {
23      "id": 214099,
24      "name": "John Doe",
25      "username": "john.doe@company.com"
26  }
27}

User invited

New user is invited to an organization.

1{
2  "timestamp": "2021-12-20T08:02:06.000Z",
3  "alert": false,
4  "description": "User invited",
5  "id": 213518499823660,
6  "event_type": {
7    "id": 36,
8    "description": "User invited"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 0,
16    "description": "Info"
17  },
18  "organisation": {
19    "id": 654321,
20    "name": "Sample Corp"
21  },
22  "user": {
23    "id": 123456,
24    "name": "Sample User",
25    "username": "abc@cde.com"
26  },
27  "detail": {
28    "id": 123457,
29    "username": "nelyInvitedUser@cde.com",
30    "name": "New Users Name",
31    "organisationId": 654321,
32    "activationKey": "JWT Token for user registration",
33    "userFederated": false
34  }
35}

Platform package and data plan

Platform package updated

Platform package changed after a contract change or self-service package upgrade.

Example: A platform package changes from Trial EUR to Trial USD or from Starter EUR to Enterprise EUR.

1{
2  "timestamp": "2021-12-20T12:27:56.000Z",
3  "alert": false,
4  "description": "Platform package 'Starter EUR' has been assigned.",
5  "id": 213779836256315,
6  "event_type": {
7    "id": 33,
8    "description": "Platform package updated"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 1,
16    "description": "Warn"
17  },
18  "organisation": {
19    "id": 654321,
20    "name": "Sample Corp"
21  },
22  "user": {
23    "id": 123456,
24    "name": "Sample User",
25    "username": "abc@cde.com"
26  },
27  "detail": {
28    "tariff_plan": { // data plan
29      "id": 301,
30      "name": "Starter EUR",
31      "start_date": "2021-12-20 12:27:56",
32      "end_date": null,
33      "evaluation": false,
34      "expiry_time": 0,
35      "price": {
36        "sim_activated_rate": [
37          {
38            "scale_start": 1,
39            "rate": 0.75
40          },
41          {
42            "scale_start": 100,
43            "rate": 0.65
44          },
45          {
46            "scale_start": 250,
47            "rate": 0.55
48          },
49          {
50            "scale_start": 500,
51            "rate": 0.45
52          },
53          {
54            "scale_start": 1000,
55            "rate": 0.4
56          },
57          {
58            "scale_start": 2500,
59            "rate": 0.3
60          },
61          {
62            "scale_start": 5000,
63            "rate": 0.28
64          }
65        ]
66      },
67      "rate": 0,
68      "yearly_rate": 0,
69      "currency": {
70        "id": 1
71      },
72      "service_level": {
73        "id": 1
74      }
75    }
76  }
77}

Data plan updated

Data plan is assigned or removed.

Example: Adding or removing Regional Pro, Global Basic, or Global Extended.

1{
2  "timestamp": "2021-12-20T12:27:57.000Z",
3  "alert": false,
4  "description": "A new data allowance has been booked in coverage area 'EU28'.",
5  "id": 213779836977183,
6  "event_type": {
7    "id": 34,
8    "description": "Data plan updated"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 1,
16    "description": "Warn"
17  },
18  "organisation": {
19    "id": 654321,
20    "name": "Sample Corp"
21  },
22  "user": {
23    "id": 123456,
24    "name": "Sample User",
25    "username": "abc@cde.com"
26  },
27  "detail": {
28    "inclusive_volume": { // data allowance
29      "ratezone_inclusive_volume_id": "145",
30      "volume": 0.25,
31      "cost": "0.020000",
32      "excess_traffic": 0.1,
33      "pooled": true,
34      "rate": 0.02,
35      "id": 3540,
36      "start_date": "2021-12-01 00:00:00",
37      "end_date": null,
38      "currency_id": 1,
39      "ratezone": { // coverage area
40        "id": 3398,
41        "name": "EU28"
42      }
43    }
44  }
45}

SIM order

The following events are only available if you’re using the Embedded SIM Shop.

Order submitted

A user submitted a SIM order.

1{
2  "timestamp": "2021-12-20T12:23:51.000Z",
3  "alert": false,
4  "description": "New SIM order has been submitted",
5  "id": 213775802007594,
6  "event_type": {
7    "id": 38,
8    "description": "Order submitted"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 0,
16    "description": "Info"
17  },
18  "organisation": {
19    "id": 654321,
20    "name": "Sampe Corp"
21  },
22  "user": {
23    "id": 123456,
24    "name": "Sample User",
25    "username": "abc@cde.com"
26  },
27  "detail": {
28    "id": 16235491,
29    "location": "/api/v1/order/16235491"
30  }
31}

Order updated

SIM order has been updated.

Possible updates:

  • Status Paid (if previously unpaid)
  • Status Shipped (including the shipping provider ID) 
    1"ext_shipping_reference": "TRACKING CODE",
    2"shipped_with_provider_id": 1,
    3"shipped_date": "2021-12-20T08:00:27.571Z"
  • Status Canceled
1{
2  "timestamp": "2021-12-20T08:00:28.000Z",
3  "alert": false,
4  "description": "SIM order has been updated",
5  "id": 213516899172361,
6  "event_type": {
7    "id": 39,
8    "description": "Order updated"
9  },
10  "event_source": {
11    "id": 2,
12    "description": "API"
13  },
14  "event_severity": {
15    "id": 1,
16    "description": "Warn"
17  },
18  "organisation": {
19    "id": 1,
20    "name": "emnify GmbH"
21  },
22  "user": {
23    "id": 123,
24    "name": "Sample Admin",
25    "username": "sample@emnify.com"
26  },
27  "detail": {
28    "id": 16235491,
29    "status": {
30      "id": 2
31    },
32    "ext_shipping_reference": "TRACKING CODE",
33    "shipped_with_provider_id": 1,
34    "shipped_date": "2021-12-20T08:00:27.571Z"
35  }
36}