Cues

Report the outcome of an active action

Report the outcome of an action previously started via /cues/{cue_id}/resolve. Requires the same signed secret used to start it. The action must still be active — otherwise a 404 is returned.

state=success marks the action as completed; it will no longer appear in the originating resource’s actions list on subsequent reads.
state=fail records the failure but leaves the action available, so the caller can retry by calling /resolve again.

POST

api

partners

v2.0

cues

{cue_id}

state

Report the outcome of an active action

curl --request POST \
  --url https://api.example.com/api/partners/v2.0/cues/{cue_id}/state \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {},
  "location": {},
  "client_info": {}
}
'

{
  "action_id": "<string>"
}

Path Parameters

cue_id

string<uuid>

required

The action's ID

Query Parameters

secret

string

required

Signed secret authorising the caller for this action

Body

application/json

state

enum<string>

required

Outcome of the action: success marks it completed, fail records a failure and leaves it available to retry.

Available options:

success,

fail

payload

Payload · object

Optional free-form payload forwarded to the action handler (e.g. provider-specific result data).

location

Location · object

Optional caller location metadata recorded alongside the outcome event.

client_info

Client Info · object

Optional caller client metadata (user-agent, device, etc.) recorded alongside the outcome event.

Response

200 - application/json

action_id

string

required

ID of the action whose outcome was recorded.

Mark an information action as readAcknowledge that the end-user has read the information message identified by the URL. Both `cue_id` and `secret` are obtained from the action's `resolution_link.url`; the `secret` is a signed token bound to a member and expires 1 hour after it is issued. Once acknowledged, the cue is marked as done and no longer appears in the device's `actions` list. The body is optional and accepts `location` / `client_info` for tracing.

Report the outcome of an active action

curl --request POST \
  --url https://api.example.com/api/partners/v2.0/cues/{cue_id}/state \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": {},
  "location": {},
  "client_info": {}
}
'

{
  "action_id": "<string>"
}