Skip to content

Webhook notification

Request

Returns the notification (invoking) list of webhooks and provides information about these. If you do not have a registered webhook, and the given event happens (for example creation of an order), the registered URLs are called. A notification about a call contains information about the webhook that requested the call, the URL called, the time, delivery status, number of delivery attempts and other information.

It is possible to request 7 days history of notification.

Security
shoptetAccessToken or shoptetPrivateApiToken
Query
statusstring

supported values: new, failed, success

Example:status=failed
eventstring

event

Example:event=order:delete
activeboolean

flag that the notification was not delivered yet, and the number of attempts did not reach the maximum amount. The notification will be resent to the target URL

Example:active=true
fromstring

DateTime for the log, up to the present, which we are interested in. + in the time zone designation, html shall be coded as %2B.

Example:from=2018-05-28T14:17:00+02:00
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/notifications?status=failed&event=order%3Adelete&active=true&from=2018-05-28T14%3A17%3A00%2B02%3A00&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": {
    "notifications": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}