Skip to main content
POST
/
v1
/
webhooks
/
test-delivery
Test webhook delivery
curl --request POST \
  --url https://api.truthlocks.com/v1/webhooks/test-delivery \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "endpoint_id": "<string>",
  "event_type": "test.ping"
}
'
{
  "success": true,
  "status_code": 123,
  "response_time_ms": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Sends a test event to a webhook endpoint using the full signing and delivery pipeline. Use this to verify that your endpoint is reachable and correctly verifying signatures before subscribing to real events. A confirmation email is sent to the authenticated user on success.

​
Parameters

​
endpoint_id
uuid
required
The ID of the webhook endpoint to test
​
event_type
string
Event type for the test payload. Defaults to webhook.test if omitted.
​
payload
object
Custom JSON payload to send. Defaults to {"status": "ok", "source": "test-delivery"} if omitted.

​
Responses

The response tells you whether the test delivery reached your endpoint and what HTTP status code it returned.
Use the test delivery endpoint during development to confirm your signature verification logic works correctly before going live. The test event goes through the same signing pipeline as real events.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
​
endpoint_id
string
required

Webhook endpoint ID to test

​
event_type
string
default:test.ping

Event type to simulate

Response

Test delivery result

​
success
boolean
​
status_code
integer
​
response_time_ms
integer