Skip to content
Authrim

Send a test webhook delivery.

POST
/api/admin/webhooks/{id}/test
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/webhooks/example/test \
  --header 'Authorization: Bearer <token>'

Test Webhook in the Webhooks area. The request body is JSON unless the detailed schema for this operation states otherwise.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Header Parameters

Section titled “Header Parameters ”
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Idempotency-Key
string

Idempotency key for state-changing operations that support replay protection.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Webhook test dispatch response.

Media type application/json
object
success
required
boolean
webhook_id
required
string
url
required
string format: uri
status_code
integer
>= 100 <= 599
response_body
string | null
error
string
duration_ms
required
integer
timestamp
string format: date-time
headers_sent
Array<string>
key
additional properties
Example 
{
  "success": true,
  "webhook_id": "webhook_123",
  "url": "https://example.com/webhooks/authrim",
  "status_code": 204,
  "response_body": null,
  "duration_ms": 142,
  "timestamp": "2026-06-19T00:00:00.000Z",
  "headers_sent": [
    "Content-Type",
    "X-Authrim-Event",
    "X-Authrim-Delivery"
  ]
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}