v1

latestOpenAPI 3.1.0Proprietary2026-07-24710198.3 KB
Webhooks

Update webhook

Update webhooks for the specified webhook id. Requires Bearer JWT authentication.

put/webhooks/{webhook_id}

Path parameters

webhook_idinteger required
Example:123

Webhook ID

Request body

urlstring

Webhook URL

Example request

{
  "url": "https://your-store.com/webhooks/envia",
  "events": [
    "shipment_created",
    "shipment_delivered",
    "shipment_in_transit"
  ]
}

Response

Successful response

successboolean

Indicates if the request was successful

dataobject

Updated webhook information