List webhooks

GET 
/openapi/2026-01/webhooks

List webhooks with a unique identifier, notification URL, event name, and format.

Request

Query Parameters

address string

Webhook notification URL, e.g. https://example.com/webhook

topic string

The event name, e.g. orders/cancelled,orders/create

created_at_min string

Filter webhook records created at after date, e.g. 2018-08-26T06:19:53Z

created_at_max string

Filter webhook records created at before date, e.g. 2018-08-26T06:19:53Z

updated_at_min string

Filter webhook records updated at after date, e.g. 2018-08-26T06:19:53Z

updated_at_max string

Filter webhook records updated at before date, e.g. 2018-08-26T06:19:53Z

page_size int32

Number of records to retrieve

page int32

Page number (1-based). Mutually exclusive with cursor

cursor string

Page cursor, used to retrieve the next page of records

Responses

200

OK

application/json

Schema

Schema

codestring

error code

messagestring

error message

data object

webhooks object[]

List of webhooks

Array [

idstring

The unique identifier of the webhook

addressstring

Webhook notification URL, e.g. https://example.com/webhook

topicstring

The topic of the webhook

created_atstring

The time of the webhook was created

updated_atstring

The time of the webhook was updated

formatstring

The format of the webhook

]

cursorstring

Page cursor, used to retrieve the next page of records

has_moreboolean

Indicates if there are more records to retrieve

Example

{
  "code": "string",
  "message": "string",
  "data": {
    "webhooks": [
      {
        "id": "string",
        "address": "string",
        "topic": "string",
        "created_at": "string",
        "updated_at": "string",
        "format": "string"
      }
    ],
    "cursor": "string",
    "has_more": true
  }
}