Skip to content
Trile Docs

Register a webhook endpoint

POST
/v1/webhooks/endpoints

The signing secret is returned exactly once, on creation. Store it — you’ll need it to verify the Trile-Signature header.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Idempotency-Key
required
string
<= 255 characters

A client-generated unique key (UUID recommended). Required on all POST/PATCH/DELETE. Retrying with the same key returns the original response for 24 hours.

Request Body required

Section titled “Request Body required ”
object
url
required
string format: uri 
https://example.com/webhooks/trile
enabledEvents
required
Array<string>
[
  "subscription.created",
  "invoice.paid",
  "invoice.payment_failed"
]
metadata

Up to 50 key/value string pairs you can attach to an object. Trile ignores them; they’re returned on every read.

object
key
additional properties
string
{
  "internal_user_id": "42"
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Endpoint registered.

object
id
string
whk_01ARZ3NDEKTSV4RRFFQ69G5FB3
url
string
secret

Returned only once.

string
whsec_...
enabledEvents
Array<string>