Skip to main content

Creates an event

POST /v1/event

Summary​

Creates an event.

Details​

Request body: JSON object. Supports either

deviceSerial or deviceID, either agent and event names or their numeric IDs,

and optional fields such as serverEvent, eventParameters, priority,

maxAttempts, and expirationEpoch.

Authentication​

No operation-level security requirement is documented here.

Parameters​

None documented here.

Request Body​

Required: Yes

application/json​

  • deviceID (integer (int64), optional)
  • deviceSerial (string, optional)
  • agentType (string, optional)
  • eventType (string, optional)
  • agentTypeID (integer (int64), optional)
  • eventTypeID (integer (int64), optional)
  • serverEvent (integer (int64), optional)
  • eventParameters (string, optional)
  • priority (integer (int64), optional)
  • maxAttempts (integer (int64), optional)
  • expirationEpoch (integer (int64), optional)

Example

{
  "deviceID": 201,
  "deviceSerial": "10001234",
  "agentType": "Device",
  "eventType": "Run",
  "agentTypeID": 1,
  "eventTypeID": 1,
  "serverEvent": 1,
  "eventParameters": "{\"presetName\":\"Run Event Preset\"}",
  "priority": 1,
  "maxAttempts": 3,
  "expirationEpoch": 1711800000
}

Responses​

200​

Success

application/json​

  • code (integer (int64), optional)
  • description (string, optional)

Example

{
  "code": 1,
  "description": "Example description"
}