> This page is for Developers.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.emnify.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.emnify.com/_mcp/server.

# List custom events

GET https://cdn.emnify.net/api/v1/event/custom/configuration

Returns a list of all available custom events and their supported targeting options.
A custom event inherits `supported_action_ids` from its template's current state, so it changes if the template does.


Reference: https://docs.emnify.com/developers/api/custom-events/get-custom-events

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Response

### 200

- `list of CustomEventOutputDto`

## Types

### CustomEventOutputDto

- `organisation` (WithIdInputDto, required)
- `template` (WithIdInputDto, required)
- `configuration_properties` (list of ConfigurationInputPropertiesDto, required)
- `name` (string, required)
- `id` (string, required)
- `supportedTargetingParameters` (list of string, required)
- `supportedActions` (list of string, required)
- `supported_action_ids` (list of string, optional) — Action IDs this event declares support for, used to decide which actions are offered for it. - Field absent: no restriction is declared, so every action whose `required_event_output_parameters` the event emits is offered. - Empty array: a declaration in its own right, so no actions are offered. - Non-empty list: intersected with the parameter check, so a listed action is offered only if the event also emits every parameter that action requires. The list can only narrow what's offered, never widen it.

### WithIdInputDto

- `id` (double, required)

### ConfigurationInputPropertiesDto

- `property` (string, required)
- `value` (string, required)
- `value_array` (list of string, required)

## Examples

**Response**

```json
[
  {
    "organisation": {
      "id": 200
    },
    "template": {
      "id": 1
    },
    "configuration_properties": [
      {
        "property": "count_of_pdp",
        "value": "10",
        "value_array": [
          "string"
        ]
      },
      {
        "property": "duration",
        "value": "1w",
        "value_array": [
          "string"
        ]
      }
    ],
    "name": "PDP Threshold 50 Over One Week",
    "id": "2",
    "supportedTargetingParameters": [
      "string"
    ],
    "supportedActions": [
      "string"
    ],
    "supported_action_ids": [
      "system-send_notification_with_email"
    ],
    "supported_actions": [
      {
        "configuration_properties": [
          {
            "default": null,
            "description": "List of email addresses to notify",
            "property": "recipients",
            "required": true,
            "type": "email[]"
          }
        ],
        "description": "Send notification via email",
        "id": "system-send_notification_with_email",
        "name": "Send notification via email",
        "required_event_output_parameters": [
          {
            "description": "Standard description of the event",
            "parameter": "event_description",
            "type": "string"
          }
        ],
        "status": "active",
        "translation_key_description": "Send notification with email D",
        "translation_key_name": "Send notification with email N",
        "type": "system"
      }
    ],
    "supported_targeting_parameters": [
      {
        "description": "Service Policy",
        "parameter": "service_policy",
        "type": "number[]"
      },
      {
        "description": "Endpoint Tag",
        "parameter": "endpoint_tag",
        "type": "string[]"
      }
    ]
  }
]
```

**SDK Code**

```python Available Custom Events
import requests

url = "https://cdn.emnify.net/api/v1/event/custom/configuration"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Available Custom Events
const url = 'https://cdn.emnify.net/api/v1/event/custom/configuration';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Available Custom Events
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://cdn.emnify.net/api/v1/event/custom/configuration"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Available Custom Events
require 'uri'
require 'net/http'

url = URI("https://cdn.emnify.net/api/v1/event/custom/configuration")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Available Custom Events
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://cdn.emnify.net/api/v1/event/custom/configuration")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Available Custom Events
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://cdn.emnify.net/api/v1/event/custom/configuration', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Available Custom Events
using RestSharp;

var client = new RestClient("https://cdn.emnify.net/api/v1/event/custom/configuration");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Available Custom Events
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://cdn.emnify.net/api/v1/event/custom/configuration")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```