ReviewsDeliver a signal to a run

Deliver a signal to a run

Delivers a signal to a run. The signal name comes from action_required.signal_name on a non-terminal run; the review signal is human_review_decision.

One route, two behaviours, and the response says which. If the run is parked on a review step, this delivers the signal and the workflow advances - "result": "signal_delivered". If the run has already finished, it records an annotation and nothing advances - "result": "review_recorded". Never infer which happened from the run's state; read result.

The verdict is the run's - there is no node_id, and sending one is a 400, not an ignored field. Re-deciding is allowed and overwrites the previous verdict. Recording a verdict does not change status or completed_at, does not re-run anything, and fires no webhook.

Both credential types work on this route: client-id + x-api-key, or a dashboard Bearer token.

curl -X POST "https://api.deepvue.link/v1/signals/123e4567-e89b-12d3-a456-426614174000/human_review_decision" \
  -H "Content-Type: application/json" \
  -H "client-id: YOUR_API_KEY" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "payload": {
    "decision": "reject",
    "notes": "KYB docs verified manually"
  }
}'
{
  "ok": true,
  "result": "review_recorded",
  "decision": "reject"
}
POST
/v1/signals/{run_id}/{signal_name}
POST
Base URLstring

Target server for requests. Edit to use your own host.

API Key (header: client-id)
client-idstring
Required

Your Deepvue client identifier.

Your Deepvue client identifier.
API Key (header: x-api-key)
x-api-keystring
Required

Your Deepvue API key. Secret - keep it server-side.

Your Deepvue API key. Secret - keep it server-side.
Bearer Token
Bearer Tokenstring
Required

A dashboard Bearer token. Accepted on the signals route only.

A dashboard Bearer token. Accepted on the signals route only.
path
signal_namestring
Required

e.g. human_review_decision, or the signal_name from action_required.

Content-Typestring
Required

The media type of the request body

Options: application/json
payloadobject
Required

For human_review_decision: decision is required and must be approve or reject; notes is optional operator text.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
client-idstring
Required

API Key for authentication. Your Deepvue client identifier.

header
x-api-keystring
Required

API Key for authentication. Your Deepvue API key. Secret - keep it server-side.

header
Authorizationstring
Required

Bearer token. A dashboard Bearer token. Accepted on the signals route only.

Path Parameters

signal_namestring
Required

e.g. human_review_decision, or the signal_name from action_required.

Example:
human_review_decision

Body

application/json
payloadobject
Required

For human_review_decision: decision is required and must be approve or reject; notes is optional operator text.

Responses

okboolean
resultstring

signal_delivered - the run was parked on a review step and the workflow advanced. review_recorded - the run had already finished and an annotation was recorded.

Allowed values:signal_deliveredreview_recorded
decisionstring
Allowed values:approvereject
Was this page helpful?