emnify Subpackage Custom Events API

The subpackage_customEvents API from emnify — 4 operation(s) for subpackage_customevents.

Operations 6

GET /api/v1/event/custom/configuration List custom events #
POST /api/v1/event/custom/configuration Deploy custom event #
GET /api/v1/event/custom/configuration/{custom_event_id} Get a custom event by ID #
DELETE /api/v1/event/custom/configuration/{custom_event_id} Delete custom event #
GET /api/v1/event/custom/template List custom event templates #
GET /api/v1/event/custom/template/{template_id} Get a custom event template by ID #

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/emnify-subpackage-customevents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

emnify-subpackage-customevents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: emnify REST Subpackage Custom Events API
  version: 1.0.0
  description: The emnify REST API gives programmatic access to the emnify IoT SuperNetwork — global cellular connectivity for IoT devices.
  contact:
    name: emnify Developer Support
    url: https://docs.emnify.com/developers
  license:
    name: Proprietary
    url: https://www.emnify.com/legal
servers:
- url: https://cdn.emnify.net
  description: emnify REST API base host
security:
- BearerAuth: []
tags:
- name: subpackage_customEvents
  x-display-name: Customevents
paths:
  /api/v1/event/custom/configuration:
    get:
      operationId: get-custom-events
      summary: List custom events
      description: Returns a list of all available custom events and their supported targeting options.
      tags:
      - subpackage_customEvents
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomEventOutputDto'
    post:
      operationId: create-custom-event-instance
      summary: Deploy custom event
      description: Deploys a custom event with the specified configuration.
      tags:
      - subpackage_customEvents
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEventOutputDto'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomEventCreateDto'
  /api/v1/event/custom/configuration/{custom_event_id}:
    get:
      operationId: get-custom-event
      summary: Get a custom event by ID
      description: Retrieves a specific custom event and its supported targeting options.
      tags:
      - subpackage_customEvents
      parameters:
      - name: custom_event_id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEventOutputDto'
    delete:
      operationId: delete-custom-event
      summary: Delete custom event
      description: Deletes a custom event with the specified configuration.
      tags:
      - subpackage_customEvents
      parameters:
      - name: custom_event_id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Custom_Events_deleteCustomEvent_Response_200'
  /api/v1/event/custom/template:
    get:
      operationId: get-custom-event-templates
      summary: List custom event templates
      description: Returns a list of all available custom event templates and their possible configuration parameters.
      tags:
      - subpackage_customEvents
      parameters:
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CustomEventTemplateOutputDto'
  /api/v1/event/custom/template/{template_id}:
    get:
      operationId: get-custom-event-template
      summary: Get a custom event template by ID
      description: Retrieves a specific custom event template and its possible configuration parameters.
      tags:
      - subpackage_customEvents
      parameters:
      - name: template_id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: Bearer authentication
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomEventTemplateOutputDto'
components:
  schemas:
    ValidatorDto:
      type: object
      properties:
        validator_type:
          type: string
        validator_value:
          type: string
      required:
      - validator_type
      - validator_value
      title: ValidatorDto
    ConfigurationPropertiesDto:
      type: object
      properties:
        property:
          type: string
        type:
          type: string
        default:
          type: string
        required:
          type: boolean
        description:
          type: string
        validators:
          type: array
          items:
            $ref: '#/components/schemas/ValidatorDto'
      required:
      - property
      - type
      - default
      - required
      - description
      - validators
      title: ConfigurationPropertiesDto
    SupportedTargetingParametersDto:
      type: object
      properties:
        parameter:
          type: string
        type:
          type: string
        description:
          type: string
        validators:
          type: array
          items:
            $ref: '#/components/schemas/ValidatorDto'
      required:
      - parameter
      - type
      - description
      - validators
      title: SupportedTargetingParametersDto
    ConfigurationInputPropertiesDto:
      type: object
      properties:
        property:
          type: string
        value:
          type: string
        value_array:
          type: array
          items:
            type: string
      required:
      - property
      - value
      - value_array
      title: ConfigurationInputPropertiesDto
    CustomEventOutputDto:
      type: object
      properties:
        organisation:
          $ref: '#/components/schemas/WithIdInputDto'
        template:
          $ref: '#/components/schemas/WithIdInputDto'
        configuration_properties:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationInputPropertiesDto'
        name:
          type: string
        id:
          type: string
        supportedTargetingParameters:
          type: array
          items:
            type: string
        supportedActions:
          type: array
          items:
            type: string
      required:
      - organisation
      - template
      - configuration_properties
      - name
      - id
      - supportedTargetingParameters
      - supportedActions
      title: CustomEventOutputDto
    CustomEventCreateDto:
      type: object
      properties:
        organisation:
          $ref: '#/components/schemas/WithIdInputDto'
        template:
          $ref: '#/components/schemas/WithIdInputDto'
        configuration_properties:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationInputPropertiesDto'
        name:
          type: string
      required:
      - organisation
      - template
      - configuration_properties
      - name
      title: CustomEventCreateDto
    WithIdInputDto:
      type: object
      properties:
        id:
          type: number
          format: double
      required:
      - id
      title: WithIdInputDto
    CustomEventTemplateOutputDto:
      type: object
      properties:
        id:
          type: string
        parent_organisation:
          $ref: '#/components/schemas/WithIdInputDto'
        name:
          type: string
        translationKeyName:
          type: string
        status:
          type: string
        description:
          type: string
        translationKeyDescription:
          type: string
        configuration_properties:
          type: array
          items:
            $ref: '#/components/schemas/ConfigurationPropertiesDto'
        supported_targeting_parameters:
          type: array
          items:
            $ref: '#/components/schemas/SupportedTargetingParametersDto'
      required:
      - id
      - parent_organisation
      - name
      - translationKeyName
      - status
      - description
      - translationKeyDescription
      - configuration_properties
      - supported_targeting_parameters
      title: CustomEventTemplateOutputDto
    Custom_Events_deleteCustomEvent_Response_200:
      type: object
      properties: {}
      description: Empty response body
      title: Custom Events_deleteCustomEvent_Response_200
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Retrieve a JWT via POST /api/v1/authenticate using an application_token or user credentials, then send it as `Authorization: Bearer <token>`.'