Event

Dequeues the next pending event for a device agent.

Request body: JSON object. Accepts either deviceSerial or deviceName.

post/v1/event/dequeue

Request

  • Base URL: https://api.actionstreamer.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.actionstreamer.com/v1/event/dequeue
  • Auth: none declared

Request body

deviceNamestring nullable
deviceSerialstring nullable
agentTypestring nullable
agentIndexinteger
processIDinteger

Example request

{
  "deviceName": "WearableDevice",
  "deviceSerial": "10001234",
  "agentType": "Device",
  "agentIndex": 1,
  "processID": 4321
}

Response

Success

keyinteger
deviceIDinteger
agentTypeIDinteger
agentIDinteger
eventTypeIDinteger
serverEventinteger
eventStatusinteger
eventParametersstring nullable
processIDinteger
resultstring nullable
percentCompletenumber double
priorityinteger
expirationEpochinteger
attemptNumberinteger
maxAttemptsinteger
tagStringstring nullable
tagNumberinteger
creationDatestring date-time nullable

Example response

{
  "key": 501,
  "deviceID": 201,
  "agentTypeID": 1,
  "agentID": 1,
  "eventTypeID": 1,
  "serverEvent": 1,
  "eventStatus": 1,
  "eventParameters": "{\"presetName\":\"Run Event Preset\"}",
  "processID": 4321,
  "result": "Example value",
  "percentComplete": 42.5,
  "priority": 1,
  "expirationEpoch": 1711800000,
  "attemptNumber": 1,
  "maxAttempts": 3,
  "tagString": "Example value",
  "tagNumber": 1,
  "creationDate": "2026-03-30T12:00:00.0000000Z"
}

Changes

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