API Reference

Create Webhook

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

Create a webhook.

šŸ”’ Requires: webhooks scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requestsā€¦
LoadingLoadingā€¦
Body Params

Webhook create/update request data.

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 about 1 month 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 about 1 month ago