Skip to content

Webhook delivery history

GET
/dashboard/v1/merchants/{merchantId}/{mode}/webhook-deliveries
curl --request GET \
--url 'http://localhost:4000/dashboard/v1/merchants/example/test/webhook-deliveries?limit=20' \
--cookie better-auth.session_token=<better-auth.session_token>
merchantId
required
string
mode
required
string
Allowed values: test live
limit
integer
default: 20 >= 1 <= 100

Deliveries

Media typeapplication/json
object
object
required
string
Allowed values: list
data
required
Array<object>
object
id
required
string
object
required
string
Allowed values: webhook_delivery
event_type
required
string
status
required
string
Allowed values: pending succeeded failed
attempts
required
integer
last_status_code
required
integer | null
last_error
required
string | null
delivered_at
required
string | null
created_at
required
string
payload
required
object
key
additional properties
has_more
required
boolean
Example
{
"object": "list",
"data": [
{
"object": "webhook_delivery",
"status": "pending"
}
]
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Sign-in required

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Forbidden

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Not found

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}

Idempotency conflict or invalid state

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": "example"
}
}