Post eventsubscriptions — devices

Creates a new event subscription. You have the option to create a temporary subscription using server-sent events or a persistent subscription using webhooks.

If you choose a temporary subscription, it will be automatically deleted if it no clients are subscribed to it for the duration specified in timeToLiveSeconds.

If you opt for a persistent subscription, it will remain active as long as you respond to the webhook messages sent to your provided URL with a 200 OK status. If we are unable to deliver events to your webhook continuously for 90 days, the subscription will be disabled.

Request body

Example request

{
  "filters": [
    {
      "actors": [
        "camera:100d4c41",
        "camera:100f12c1",
        "camera:*"
      ],
      "types": [
        {
          "id": "een.deviceCloudStatusUpdateEvent.v1"
        }
      ],
      "data": {
        "and": [
          {
            "field": "een.lprDetection.v1.plate",
            "op": "exact",
            "value": "ABC123"
          },
          {
            "field": "een.lprDetection.v1.plateConfidence",
            "op": "gte",
            "value": 0.9
          }
        ],
        "not": [
          {
            "field": "een.lprDetection.v1.plateRegion",
            "op": "in",
            "value": [
              "EU-DE",
              "EU-FR"
            ]
          }
        ]
      }
    }
  ]
}

Response

EventSubscription created

idstring required

Unique identifier of the subscriptionId.

Example response

{
  "id": "f3d6f55d5ba546168758a309508f4419",
  "subscriptionConfig": {
    "lifeCycle": "temporary",
    "timeToLiveSeconds": 900
  },
  "deliveryConfig": {
    "sseUrl": "https://api.c013.eagleeyenetworks.com/sse/v3.0/eventSubscriptions/f3d6f55d5ba546168758a309508f4419"
  }
}