Skip to content

Update of existing webhook

Request

Modification of the existing webhook. The id of the webhook serves as the identifier. Using just one call, only one webhook can be modified.

Setting sendPayload for an event that does not support it fails with 400 and the webhook-send-payload-not-supported error.

Please note that url cannot be longer than 2000 characters.

Security
shoptetAccessToken or shoptetPrivateApiToken
Path
idintegerrequired
Example:3
Headers
Content-Typestringrequired
Default:"application/json"
Bodyapplication/json
dataobject, non-emptyrequired
curl -i -X PATCH \
  https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/webhooks/3 \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE' \
  -d '{
    "data": {
      "url": "https://myapplication.tld/orders-new.php",
      "sendPayload": "full"
    }
  }'

Responses

OK

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