v1

latestOpenAPI 3.0.32026-07-243003151.2 MB

Units

Create Unit Event Configuration (BETA)

This method allows the calling application to create Unit Event configuration. This endpoint can only be called once to create the configuration. Please note that the unitId must be that of the calling unit.

post/units/{unitId}/events

Path parameters

unitIdstring Int64 required

EES AIR Unit ID.

Headers

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

Request body

Example request

{
  "recipients": [
    {
      "type": "AUTHENTICATED_REQUEST",
      "recipientDetails": {
        "url": "https://example.com/unit-events",
        "requestMethod": "POST",
        "authenticationType": "oauth2",
        "expectedHttpCodes": [
          200,
          201,
          204
        ],
        "headers": {
          "Content-Type": "application/json",
          "Accept": "*/*"
        },
        "authentication": {
          "grantType": "password",
          "endpoint": "https://example.com/oauth2/token",
          "scope": "openid",
          "clientId": "exampleClientId",
          "clientSecret": "exampleClientSecret",
          "username": "exampleUsername",
          "password": "examplePassword"
        }
      },
      "enabled": true
    }
  ]
}

Response

Successful Response with Unit Event Configuration Payload

dateCreatedstring date-time

The date-time when the Unit Event configuration was added to the AIR platform.

lastUpdatedstring date-time

The date-time when the Unit Event configuration was last updated on in the AIR platform.

Example response

{
  "recipients": [
    {
      "id": "123",
      "type": "AUTHENTICATED_REQUEST",
      "recipientDetails": {
        "url": "https://example.com/unit-events",
        "requestMethod": "POST",
        "authenticationType": "oauth2",
        "expectedHttpCodes": [
          200,
          201,
          204
        ],
        "headers": {
          "Content-Type": "application/json",
          "Accept": "*/*"
        },
        "authentication": {
          "grantType": "password",
          "endpoint": "https://example.com/oauth2/token",
          "scope": "openid"
        }
      },
      "enabled": true
    }
  ],
  "dateCreated": "2025-11-15 12:34:58",
  "lastUpdated": "2025-11-20 15:47:58"
}