Skip to main content
POST
/
webhooks
/
{webhookId}
/
ping
Ping Webhook
curl --request POST \
  --url https://api.dfns.io/webhooks/{webhookId}/ping \
  --header 'Authorization: Bearer <token>' \
  --header 'X-DFNS-USERACTION: <api-key>'
{
  "status": "<string>",
  "error": "<string>"
}

​
Authentication

✅ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
✅ Service Account

​
Required Permissions

Webhooks:Ping: Always required.

Authorizations

​
Authorization
string
header
required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

​
X-DFNS-USERACTION
string
header
required

User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows

Path Parameters

​
webhookId
string
required
Minimum string length: 1

Response

200 - application/json

Success

​
status
string
required
​
error
string