LIlightspeed
Staff

Update Existing Webhook

Changed on

Updates the details of an existing webhook.

patch/staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/staff/v1/businessLocations/{businessLocationId}/webhooks/{webhookId}
  • 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: staff-api

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

webhookIdstring uuid required

The unique identifier for the webhook.

Request body

notificationType'shift.created' | 'shift.updated' | 'shift.deleted' required

The type of webhook notification.

urlstring uri required

The URL for the webhook.

webhookNamestring required

The name for the webhook.

Response

Webhook updated successfully

uuidstring uuid

The unique identifier for the webhook.

notificationType'shift.created' | 'shift.updated' | 'shift.deleted'

The type of webhook notification.

urlstring

The URL for the webhook.

webhookNamestring

The name for the webhook.

businessLocationIdinteger

The unique identifier for the business location.

createdAtstring date-time

The creation time of the webhook.

updatedAtstring date-time

The last update time of the webhook.

Example response

{
  "uuid": "e95c2cc5-4489-4025-a7e2-a34faeaa5f9d",
  "webhookName": "My Awesome Webhook",
  "businessLocationId": 1234567890
}

Changes