Webhook List

GET 
/openapi/2022-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 last update at after date, e.g. 2018-08-26T06:19:53Z

updated_at_max string

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

limit int32
Result per page, max: 250
Default value: 50
page int32

Page number

Responses

200

200

application/json

Schema

Schema

webhooks object[]
Array [
idstring
Example: ea88df20-525b-457b-beed-d49e546be683
addressstring
Example: https://example.com/webhook
topicstring
Example: orders/create
created_atstring
Example: 2018-08-26T06:30:55Z
updated_atstring
Example: 2018-08-26T06:30:55Z
formatstring
Example: json
]

Example

{
  "webhooks": [
    {
      "id": "ea88df20-525b-457b-beed-d49e546be683",
      "address": "https://example.com/webhook",
      "topic": "orders/create",
      "created_at": "2018-08-26T06:30:55Z",
      "updated_at": "2018-08-26T06:30:55Z",
      "format": "json"
    }
  ]
}

Result

{
  "webhooks": [
    {
      "id": "ea88df20-525b-457b-beed-d49e546be683",
      "address": "https://example.com/webhook",
      "topic": "orders/create",
      "created_at": "2018-08-26T06:30:55Z",
      "updated_at": "2018-08-26T06:30:55Z",
      "format": "json"
    },
    {
      "id": "2c3772b4-8a92-4afd-bb7b-d89cd31844c2",
      "address": "https://example.com/webhook",
      "topic": "orders/delete",
      "created_at": "2018-08-26T06:30:55Z",
      "updated_at": "2018-08-26T06:30:55Z",
      "format": "json"
    }
  ]
}

422

422

application/json

Schema

Schema

oneOf
• object
• object
errors object
limitstring[]
pagestring[]

Example

{
  "errors": {
    "limit": [
      "must be less than or equal to 250"
    ],
    "page": [
      "must be greater than or equal to 1"
    ]
  }
}

Result

{
  "errors": [
    "Address is invalid",
    "Topic is not allowed, allowed topic are: app/expired,app/uninstalled,cart/create,cart/update,collections/create,collections/delete,collections/update,customers/create,customers/delete,customers/update,fulfillments/create,fulfillments/update,orders/cancelled,orders/create,orders/delete,orders/finished,orders/fulfilled,orders/paid,orders/partially_fulfilled,orders/partially_refunded,orders/refunded,orders/update,procurements/create,procurements/update,products/create,products/delete,products/publish,products/unpublish,products/update,shop/update,stores/subscribe,suppliers/create,suppliers/delete,suppliers/update,themes/create,themes/delete,themes/publish,themes/update"
  ]
}