Skip to main content
POST
/
v1
/
webhooks
/
endpoints
Create webhook endpoint
curl --request POST \
  --url https://api.truthlocks.com/v1/webhooks/endpoints \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "event_filters": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "status": "<string>",
  "secret": "<string>",
  "event_filters": [
    "<string>"
  ],
  "created_at": "<string>"
}

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.

Registers a new webhook endpoint for the authenticated tenant. The endpoint receives HTTP POST requests when matching events occur. The endpoint secret is returned once in the response — store it securely.
The number of webhook endpoints you can create depends on your billing plan. If you exceed your plan limit, the API returns 402 Payment Required.

​
Parameters

​
name
string
required
Human-readable name for the endpoint (e.g., “My Backend”)
​
url
string
required
Publicly reachable HTTPS URL that receives webhook deliveries
​
event_filters
string[]
required
List of event types or wildcard patterns to subscribe to. Use category.* to subscribe to all events in a category (e.g., attestation.*). See the webhooks guide for the full list of event types.

​
Responses

The secret field is only returned in the creation response. Store it securely — you cannot retrieve it later. If you lose it, rotate the secret to generate a new one.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Body

application/json
​
name
string
required

Human-readable endpoint name

​
url
string
required

HTTPS URL for webhook deliveries

​
event_filters
string[]
required

Event types or wildcard patterns

Response

Endpoint created

​
id
string
​
name
string
​
url
string
​
status
string
​
secret
string
​
event_filters
string[]
​
created_at
string