{ "opencollection": "1.0.0", "info": { "name": "Lightspeed Restaurant K Series Account Order and Pay: Webhook API", "version": "1.0.0" }, "items": [ { "info": { "name": "Order and Pay: Webhook", "type": "folder" }, "items": [ { "info": { "name": "Lightspeed Update a Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://api.trial.lsk.lightspeed.app/o/wh/1/webhook", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Updates an existing webhook entry.\n\nImportant Note: if `provideAccount`, `expandTransactions`, or `expandPayments` are excluded from the update request, they will be reset to their default values." }, { "info": { "name": "Lightspeed Create a Webhook", "type": "http" }, "http": { "method": "PUT", "url": "https://api.trial.lsk.lightspeed.app/o/wh/1/webhook", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Configures a new webhook to be used for order status updates." }, { "info": { "name": "Lightspeed Retrieve a Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://api.trial.lsk.lightspeed.app/o/wh/1/webhook/:endpointId", "params": [ { "name": "endpointId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Retrieve an existing webhook." }, { "info": { "name": "Lightspeed Delete a Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.trial.lsk.lightspeed.app/o/wh/1/webhook/:endpointId", "params": [ { "name": "endpointId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Delete an existing webhook." }, { "info": { "name": "Lightspeed Get Webhook Business Locations", "type": "http" }, "http": { "method": "GET", "url": "https://api.trial.lsk.lightspeed.app/o/wh/1/webhook/:endpointId/business-locations", "params": [ { "name": "endpointId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Get all business locations added to a webhook endpoint via the API." }, { "info": { "name": "Lightspeed Add a Business Location to a Webhook", "type": "http" }, "http": { "method": "PUT", "url": "https://api.trial.lsk.lightspeed.app/o/wh/1/webhook/:endpointId/business-locations/:businessLocationId", "params": [ { "name": "businessLocationId", "value": "", "type": "path" }, { "name": "endpointId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Enables a webhook for the specified business location.\nRequired to receive item availability notifications (type 'item').\nNot required for 'order' and 'payment' webhooks." }, { "info": { "name": "Lightspeed Remove Business Location from a Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.trial.lsk.lightspeed.app/o/wh/1/webhook/:endpointId/business-locations/:businessLocationId", "params": [ { "name": "businessLocationId", "value": "", "type": "path" }, { "name": "endpointId", "value": "", "type": "path" } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "/oauth/authorize", "accessTokenUrl": "/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Remove a business location ID from a webhook endpoint." } ] } ], "bundled": true }