LIlightspeed
Order and Pay: Webhook

Add a Business Location to a Webhook

Changed on

Enables a webhook for the specified business location. Required to receive item availability notifications (type 'item'). Not required for 'order' and 'payment' webhooks.

put/o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}
  • Auth
    OAuth 2
    Authorization code: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth
    Token URL: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token scopes: orders-api

Path parameters

endpointIdstring required
Example:endpoint
businessLocationIdinteger required

The unique identifier for the business location.

Example:45454565682155

Response

OK

businessLocationIdinteger required

The unique identifier for the business location.

createdAtstring date-time

Timestamp when this association was created.

updatedAtstring date-time

Timestamp when this association was last updated.

Example response

{
  "businessLocationId": 45454565682155,
  "createdAt": "2023-11-07T19:15:05.043+0000",
  "updatedAt": "2023-11-07T19:15:05.043+0000"
}

Changes