API Reference

Update Webhook

put
https://{domain_prefix}.retail.lightspeed.app/api/2026-04/webhooks/

Update an existing webhook

🔒 Requires: webhooks scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
boolean
required

Whether this webhook is enabled or not

string
required

The webhook type. These can be one of:

  • sale.update
  • product.update
  • customer.update
  • inventory.update
  • register_closure.create
  • consignment.send
  • consignment.receive
string
required
length ≥ 3

The URL to send webhooks to

Responses

Updated 3 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago