List custom event templates | emnify Documentation

import requests
url = "https://cdn.emnify.net/api/v1/event/custom/template"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

[
  {
    "id": "1",
    "parent_organisation": {
      "id": 42
    },
    "name": "PDP Threshold Count Over Time",
    "translationKeyName": "PDP_THRESHOLD_COUNT_OVER_TIME_N",
    "status": "published",
    "description": "This event is triggered when more than 5 PDPs are created in 1 week.",
    "translationKeyDescription": "PDP_THRESHOLD_COUNT_OVER_TIME_D",
    "configuration_properties": [
      {
        "property": "count_of_pdp",
        "type": "integer",
        "default": "5",
        "required": true,
        "description": "Number of PDP connections",
        "validators": [
          {
            "validator_type": "min",
            "validator_value": "1"
          },
          {
            "validator_type": "max",
            "validator_value": "100"
          }
        ]
      },
      {
        "property": "duration",
        "type": "string",
        "default": "1w",
        "required": true,
        "description": "Duration of the PDP connection period (for example, '1D', '1w')",
        "validators": [
          {
            "validator_type": "pattern",
            "validator_value": "^[1-9][0-9]*[dDwWmM]$"
          }
        ]
      }
    ],
    "supported_targeting_parameters": [
      {
        "parameter": "service_policy",
        "type": "number[]",
        "description": "Service Policy",
        "validators": [
          {
            "validator_type": "minItems",
            "validator_value": "1"
          }
        ]
      },
      {
        "parameter": "endpoint_tag",
        "type": "string[]",
        "description": "Endpoint Tag",
        "validators": [
          {
            "validator_type": "maxLength",
            "validator_value": "50"
          }
        ]
      }
    ]
  }
]

Returns a list of all available custom event templates and their possible configuration parameters.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

idstring

parent_organisationobject

namestring

translationKeyNamestring

statusstring

descriptionstring

translationKeyDescriptionstring

configuration_propertieslist of objects

supported_targeting_parameterslist of objects

1	[
2	{
3	"id": "1",
4	"parent_organisation": {
5	"id": 42
6	},
7	"name": "PDP Threshold Count Over Time",
8	"translationKeyName": "PDP_THRESHOLD_COUNT_OVER_TIME_N",
9	"status": "published",
10	"description": "This event is triggered when more than 5 PDPs are created in 1 week.",
11	"translationKeyDescription": "PDP_THRESHOLD_COUNT_OVER_TIME_D",
12	"configuration_properties": [
13	{
14	"property": "count_of_pdp",
15	"type": "integer",
16	"default": "5",
17	"required": true,
18	"description": "Number of PDP connections",
19	"validators": [
20	{
21	"validator_type": "min",
22	"validator_value": "1"
23	},
24	{
25	"validator_type": "max",
26	"validator_value": "100"
27	}
28	]
29	},
30	{
31	"property": "duration",
32	"type": "string",
33	"default": "1w",
34	"required": true,
35	"description": "Duration of the PDP connection period (for example, '1D', '1w')",
36	"validators": [
37	{
38	"validator_type": "pattern",
39	"validator_value": "^[1-9][0-9]*[dDwWmM]$"
40	}
41	]
42	}
43	],
44	"supported_targeting_parameters": [
45	{
46	"parameter": "service_policy",
47	"type": "number[]",
48	"description": "Service Policy",
49	"validators": [
50	{
51	"validator_type": "minItems",
52	"validator_value": "1"
53	}
54	]
55	},
56	{
57	"parameter": "endpoint_tag",
58	"type": "string[]",
59	"description": "Endpoint Tag",
60	"validators": [
61	{
62	"validator_type": "maxLength",
63	"validator_value": "50"
64	}
65	]
66	}
67	]
68	}
69	]