Skip to content

List all webhooks

GET
/webhook

Retrieves a paginated list of webhooks

Authorizations

Parameters

Query Parameters

page
integer

Page number for pagination

limit
integer
default: 10 >= 1 <= 100

Number of items per page

Responses

200

Successfully retrieved webhooks list

object
webhooks
required
Array<object>
object
webhookId

The unique id for the webhook

string format: uuid
name

The name of the webhook

string
description

The description of the webhook

string
url
required

The url of the webhook

string format: uri
enabledEvents
required

A list of event names that this webhook is configured to listen to

Array<string>
signingSecret

The secret used to sign the webhook payload

string
status

The status of the webhook

string
Allowed values: active paused disabled
lastTriggeredAt

The date and time the webhook was last triggered

string format: date-time
createdAt

The date and time the webhook was created

string format: date-time
meta
required
object
page
required

Current page number

integer
pageSize
required

Number of items per page

integer
totalPages

Total number of pages available

integer
totalCount

Total number of items available

integer

401

Unauthorized

object
code
required

HTTP status code

integer
status
required

Error status message

string

500

Internal Server Error

object
code
required

HTTP status code

integer
status
required

Error status message

string