API Reference
Getting startedVisit een.comMy Application/Login

/events

post
https://{BaseUrl}/api/v3.0/events

Creates a new event and adds it to the history of the selected actor. The event must be from the list of supported event types. For more information, please review the Event Insertion Guide.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Parent for envelope for een events

date-time
required

Time at which the event starts.

date-time | null
required

Time at which the event ended. If null, the event is ongoing.

boolean
required

True if the event describes a period of time instead of a single moment in time.

string
required

Id of the account the event belongs in. This can be a different account than the account of the actor that changed as part of the event, see the actorAccountId description for more details.

string
required

Id of the entity that changed as part of the event, such as a camera id, user id, or account id. This id represents the specific entity that underwent a change, triggering the event notification.

string
required

Id of the account to which the changed actor belongs. This might be different from the accountId field in cases where one account is helping to manage another one. For example, a reseller that manages the bridges for one of their end-users would want to get alerts in their own account (accountId) that are about bridges located in their end-user's account (actorAccountId).

string
enum
required
Defaults to camera

Type of actor that changed, triggering the event.

string
required
Defaults to unknown

Id of the application or system that created this event. This id should not differ between instances or even versions of the same application.

string
enum
required

Specific event type, e.g. een.motionDetectionEvent.v1, een.lprPlateReadEvent.v1

Allowed:
dataSchemas
array of strings
required

List of all data schema types that can be found in this event.

dataSchemas*
data
array of objects
required

Event specific data given as an array of objects that have a type field indicates the schema of the value.

data*
Responses

Updated 6 months ago

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago