Skip to content

Overview of registered webhooks

Request

Returns the list of webhooks, registered by the specific addon for a single e-shop. It is therefore bound to the specific installation.

The addon does not have any access to another addon (not even for the same e-shop, or two addons from the same developer).

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
itemsPerPageinteger

Returned items per page. Default value is 20. Max value is 500.

Example:itemsPerPage=50
pageinteger

Page number to return. Default value is 1.

Example:page=3
Headers
Content-Typestringrequired
Default:"application/json"
curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/webhooks?itemsPerPage=50&page=3' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
dataobjectrequired
errorsArray of objects or null(Errors)required
metadataobject(Metadata)required
Response
{
  "data": {
    "webhooks": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}