Get a custom event template by ID | emnify Documentation

import requests
url = "https://cdn.emnify.net/api/v1/event/custom/template/template_id"
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": "^[0-9]+[dDwWmMyY]$"
        }
      ]
    }
  ],
  "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"
        }
      ]
    }
  ]
}

Retrieves a specific custom event template and its possible configuration parameters.

Authentication

AuthorizationBearer

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

Path parameters

template_idstringRequired

Response

idstring

parent_organisationobject

namestring

translationKeyNamestring

statusstring

descriptionstring

translationKeyDescriptionstring

configuration_propertieslist of objects

supported_targeting_parameterslist of objects

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