ANangelcam
event

Create event

This endpoint has rate limiting in place. The endpoint will accept at most 10 requests per minute for a given hash (see Nuts and bolts for more details).

post/events/

Request

Request body

hashstring required

Event API hash (a unique token for each sensor found in My Angelcam dashboard or obtained via Sensor Resource) - used to authenticate the request and pair the event with corresponding sensor.

titlestring
occurred_atstring datetime

Example request

{
  "hash": "50yxnlu2o2"
}

Response

Event was received

camerainteger nullable required

Camera ID

locationinteger nullable required

Location ID

siteinteger nullable required

Location ID. Deprecated: use location instead.

titlestring nullable required

Event title

categorystring required

event category

sourcestring required

Name of event source

occurred_atstring datetime required

Time when event occurred or was received by Angelcam

received_atstring datetime required

Time when event was received by Angelcam

Example response

{
  "title": "Door open",
  "camera": 20,
  "location": null,
  "site": null,
  "source": "smtp",
  "category": "motion_detected",
  "received_at": "2018-10-24T11:21:59.000Z",
  "occurred_at": "2018-10-24T11:21:39.000Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.