Sign in

v1

latestOpenAPI 3.1.02026-08-06911,228852.2 KB
Staff

Create Webhook

post/staff/v1/businessLocations/{businessLocationId}/webhooks

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

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 Created

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
}