WorkflowsSet the run-completion webhook

Set the run-completion webhook

Add-only: sets the URL when none is configured, 409 otherwise.

curl -X POST "https://api.deepvue.link/v1/workflows/123e4567-e89b-12d3-a456-426614174000/webhook" \
  -H "Content-Type: application/json" \
  -H "client-id: YOUR_API_KEY" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{
  "lifecycle_webhook_url": "https://your-app.example.com/hooks/kyc"
}'
{
  "id": "e97e7d78-4ceb-4283-8080-5c5e0b72ddac",
  "name": "Individual KYC",
  "description": "PAN, e-Aadhaar and face match",
  "published": true,
  "run_ttl_seconds": 86400,
  "abandon_timeout_seconds": 3600,
  "created_at": "2026-06-01T10:00:00Z"
}
POST
/v1/workflows/{id}/webhook
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.
path
idstring
Required

The workflow's UUID.

Format: uuid
Content-Typestring
Required

The media type of the request body

Options: application/json
lifecycle_webhook_urlstring
Required

An absolute http(s) URL.

Format: uri
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.

Path Parameters

idstring
Required

The workflow's UUID.

Body

application/json
lifecycle_webhook_urlstring
Required

An absolute http(s) URL.

Example:
https://your-app.example.com/hooks/kyc

Responses