Monitor any bot that can send an HTTP request.

POST https://app.robovue.co.uk/ingest/{tenantId}/runs

The endpoint both SDKs call, and the one to use from any other language.

Headers

Content-Type Required

application/json

The body is JSON. A charset parameter is fine.

X-Robovue-Delivery-Id Required

1–200 printable ASCII characters, no spaces

Unique to this run. Sending it again — a retry, or the Success/Failure that ends a Running run — updates or confirms the same run instead of creating a second one. A GUID, or your bot’s own run id, both work.

X-Robovue-Timestamp Required

Unix time in whole seconds

When you signed the request. It must be within 5 minutes of Robovue’s clock either way, so a captured request stops working within minutes. Sign each attempt, retries included, just before sending it.

X-Robovue-Signature Required

v1=<lowercase hex>

HMAC-SHA256, keyed with your webhook secret, of the timestamp, the word run, the delivery id — each followed by a line break — then the exact request body; hex-encoded in lowercase and prefixed with v1=. Sign the exact bytes you send: re-serialising the JSON after signing changes them. Several comma-separated v1= values are accepted, and any one matching is enough.

X-Robovue-Dry-Run Optional

true

Checks the request exactly as a real one — authentication, every field, the delivery id, your plan’s bot limit — and stores nothing. The response says what would have happened. Use it to test an integration without creating runs. Any other value, or no header, is an ordinary request.

Body

A JSON object with the fields below.

botId string, up to 200 characters Required

Your name for the bot. Every run with the same botId is the same bot on your dashboard. Spaces and punctuation are fine; not / or \, no spaces at either end, and no tabs or line breaks. The same id registers and manages the bot through the Management API.

For example invoice-bot-01

platform string, up to 50 characters Required

What runs the bot, shown beside it on the dashboard — any short label, such as dotnet, python, go or blue-prism. Same whitespace rules as botId.

For example python

status string Required

How the run went. Running reports a run that has started and not finished yet; send the same delivery id again with Success or Failure when it ends. Values are case-sensitive.

One of Success Failure Running

For example Success

startedAt timestamp Required

When the run started, as an RFC 3339 timestamp with a time zone offset — Z for UTC or ±hh:mm, e.g. 2026-07-17T09:00:00Z. Not before 2000, and not more than an hour ahead of Robovue’s clock. Unix times aren’t accepted.

For example 2026-07-17T09:00:00Z

completedAt timestamp Sometimes

Required when status is Success or Failure; leave it out when status is Running

When the run finished. Same format and limits as startedAt, and not before it.

For example 2026-07-17T09:01:30Z

failureCategory string Optional

Only with status Failure

Why the run failed, if your bot can tell. Leave it out if not — it becomes Uncategorized and can be changed later on the run’s page. Values are case-sensitive.

One of Uncategorized BusinessException ApplicationException Timeout AuthenticationError Cancelled

For example ApplicationException

payload object Optional

Anything that will help you debug the run later — an invoice number, the step that failed, a stack trace. Must be a JSON object; it’s stored as sent and shown on the run’s page. A top-level error, errorMessage or message string becomes the summary in the failure alert. Counts toward the 64 KB request limit.

For example { "invoiceId": "INV-2291", "error": "Timed out waiting for the vendor portal" }