Skip to main content
POST
Dispatch Execution
Use this API to start a new execution of a workflow definition. Dispatch pins the current definition version, stamps a correlation ID and idempotency key, and enqueues the first step(s).

Endpoint

POST https://api.velt.dev/v2/workflow/executions/dispatch

Headers

x-velt-api-key
string
required
Your API key.
x-velt-auth-token
string
required

Body

Params

data
object
required
webhookUrl is validated at the schema boundary and re-checked at delivery time. Scheme must be https://. Literal IP hosts in loopback, private (RFC 1918), link-local, or IPv4-mapped-private ranges are rejected. Forbidden hostnames include localhost, metadata.google.internal, metadata, and any *.internal. At delivery, DNS resolution is repeated; if any resolved address is private, the request is not sent. Redirects are never followed.

Example Requests

Dispatch with idempotency and webhook

Response

Success Response

deduplicated: true indicates a replay (including in-tx contention) — the returned executionId is the original execution’s id.

Failure Response

Errors: NOT_FOUND (no definition or tombstoned) / FAILED_PRECONDITION (tombstoned) / INVALID_ARGUMENT (schema validation).