---
title: "Create Webhook"
method: POST
path: "/staff/v1/businessLocations/{businessLocationId}/webhooks"
tags: ["Staff"]
---

# Create Webhook

`POST /staff/v1/businessLocations/{businessLocationId}/webhooks`

## Request

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

- `businessLocationId` integer, required

## Request body

- StaffApiCreateWebhookRequest
  - `notificationType` 'shift.created' | 'shift.updated' | 'shift.deleted', required: The type of webhook notification.
  - `url` string, uri, required: The URL for the webhook.
  - `webhookName` string, required: The name for the webhook.

## Response `200`

Webhook Created

- StaffApiWebhookDto
  - `uuid` string, uuid: The unique identifier for the webhook.
  - `notificationType` 'shift.created' | 'shift.updated' | 'shift.deleted': The type of webhook notification.
  - `url` string: The URL for the webhook.
  - `webhookName` string: The name for the webhook.
  - `businessLocationId` integer: The unique identifier for the business location.
  - `createdAt` string, date-time: The creation time of the webhook.
  - `updatedAt` string, date-time: The last update time of the webhook.

## Changes

> 31 revisions in range; 1 not diffed.

- **2024-09-15** `4c87668cd4dd`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/changes/staff/v1/businessLocations/:businessLocationId/webhooks/post.md)

---

[API](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api.md) - [All operations](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lightspeed/apis/lightspeed-restaurant-k-series-api/revisions/af001485cf2b?raw)