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": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({endpoint_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://api.truthlocks.com/v1/webhooks/test-delivery', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/webhooks/test-delivery"
payload = { "endpoint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/webhooks/test-delivery"
payload := strings.NewReader("{\n \"endpoint_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"status_code": 123,
"response_time_ms": 123
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}Webhooks
Send test delivery
Sends a test event to a webhook endpoint to verify connectivity.
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": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({endpoint_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'})
};
fetch('https://api.truthlocks.com/v1/webhooks/test-delivery', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.truthlocks.com/v1/webhooks/test-delivery"
payload = { "endpoint_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.truthlocks.com/v1/webhooks/test-delivery"
payload := strings.NewReader("{\n \"endpoint_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"status_code": 123,
"response_time_ms": 123
}{
"code": "AUTH_REQUIRED",
"message": "Authentication required",
"http_status": 401
}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.
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
API key for machine-to-machine authentication
Body
application/json