Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

An API key, pk_live_… or pk_test_….

Body

application/json
url
string
required

https

topics
string[]
required
name
string

optional; the URL's host when empty

Example:

"First wallet"

Response

OK

id
string

whe_…

name
string
url
string
topics
string[]

an event type, a group like entry.*, or *

health
enum<string>

FAILING: something failed or needed a retry in the last 24 hours

IDLE: nothing sent yet

Available options:
HEALTHY,
FAILING,
IDLE
delivered
string<int64>

The last 24 hours. A 64-bit integer, written as a string.

failed
string<int64>

gave up after the last retry A 64-bit integer, written as a string.

pending
string<int64>

waiting for a first try or a retry A 64-bit integer, written as a string.

p95Ms
string<int64>

A 64-bit integer, written as a string.

failedByHour
string<int64>[]

24 buckets, oldest first: deliveries that failed or needed a retry

A 64-bit integer, written as a string.

lastFailureAt
string<date-time>
createdAt
string<date-time>
secret
string

only in the answer to CreateEndpoint