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"
}'
import requests
import json
url = "https://api.deepvue.link/v1/workflows/123e4567-e89b-12d3-a456-426614174000/webhook"
headers = {
"Content-Type": "application/json",
"client-id": "YOUR_API_KEY",
"x-api-key": "YOUR_API_KEY"
}
data = {
"lifecycle_webhook_url": "https://your-app.example.com/hooks/kyc"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.deepvue.link/v1/workflows/123e4567-e89b-12d3-a456-426614174000/webhook", {
method: "POST",
headers: {
"Content-Type": "application/json",
"client-id": "YOUR_API_KEY",
"x-api-key": "YOUR_API_KEY"
},
body: JSON.stringify({
"lifecycle_webhook_url": "https://your-app.example.com/hooks/kyc"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"lifecycle_webhook_url": "https://your-app.example.com/hooks/kyc"
}`)
req, err := http.NewRequest("POST", "https://api.deepvue.link/v1/workflows/123e4567-e89b-12d3-a456-426614174000/webhook", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("client-id", "YOUR_API_KEY")
req.Header.Set("x-api-key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.deepvue.link/v1/workflows/123e4567-e89b-12d3-a456-426614174000/webhook')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['client-id'] = 'YOUR_API_KEY'
request['x-api-key'] = 'YOUR_API_KEY'
request.body = '{
"lifecycle_webhook_url": "https://your-app.example.com/hooks/kyc"
}'
response = http.request(request)
puts response.body
{
"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"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "missing credentials: send client-id + x-api-key headers"
}
{
"error": "invalid Deepvue credentials"
}
{
"error": "Conflict",
"message": "The request conflicts with the current state of the resource",
"code": 409,
"details": "Resource already exists"
}
POST
/v1/workflows/{id}/webhookPOST
Base URLstring
Target server for requests. Edit to use your own host.
API Key (header: client-id)
client-idstring
RequiredYour Deepvue client identifier.
Your Deepvue client identifier.
API Key (header: x-api-key)
x-api-keystring
RequiredYour Deepvue API key. Secret - keep it server-side.
Your Deepvue API key. Secret - keep it server-side.
path
idstring
RequiredThe workflow's UUID.
Format: uuid
Content-Typestring
RequiredThe media type of the request body
Options: application/json
lifecycle_webhook_urlstring
RequiredAn absolute http(s) URL.
Format: uri
Request Preview
Response
Response will appear here after sending the request
Authentication
header
client-idstring
RequiredAPI Key for authentication. Your Deepvue client identifier.
header
x-api-keystring
RequiredAPI Key for authentication. Your Deepvue API key. Secret - keep it server-side.
Path Parameters
idstring
RequiredThe workflow's UUID.
Body
application/json
lifecycle_webhook_urlstring
RequiredAn absolute http(s) URL.
Example:
https://your-app.example.com/hooks/kycResponses
Was this page helpful?