Skip to main content
POST
/
v3
/
webhook
/
destinations
Create Webhook Destination
curl --request POST \
  --url https://verification.didit.me/v3/webhook/destinations/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "label": "<string>",
  "url": "<string>",
  "subscribed_events": [
    "<string>"
  ],
  "enabled": true,
  "webhook_version": "v1"
}
'
{
  "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "label": "<string>",
  "url": "<string>",
  "enabled": true,
  "webhook_version": "v1",
  "secret_shared_key": "<string>",
  "subscribed_events": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "summary": {
    "total_deliveries": 123,
    "failed_deliveries": 123,
    "error_rate_percentage": 123,
    "min_response_time_ms": 123,
    "avg_response_time_ms": 123,
    "max_response_time_ms": 123,
    "last_delivery_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json
label
string
required
url
string<uri>
required
subscribed_events
string[]
required
enabled
boolean
default:true
webhook_version
enum<string>
Available options:
v1,
v2,
v3

Response

201 - application/json

Webhook destination created.

uuid
string<uuid>
label
string
url
string<uri>
enabled
boolean
webhook_version
enum<string>
Available options:
v1,
v2,
v3
secret_shared_key
string
subscribed_events
string[]
created_at
string<date-time>
updated_at
string<date-time>
summary
object