---
title: "Update a webhook"
method: POST
path: "/o/wh/1/webhook"
tags: ["Order and Pay: Webhook"]
---

# Update a webhook

`POST /o/wh/1/webhook`

Updates an existing webhook entry.

Important Note: if `provideAccount`, `expandTransactions`, or `expandPayments` are excluded from the update request, they will be reset to their default values.

## Request body

- ApeWebhookEndpoint
  - `endpointId` string, required — The unique endpoint ID, for example the integration name. Case sensitive.
  - `url` string, required — The URL which this endpoint points to.
  - `withBasicAuth` boolean — If basic auth should be used, defaults to false.
  - `username` string — The username for basic auth.
  - `password` string — The password for basic auth.
  - `provideAccount` boolean — Whether or not to include account info in the notification.
  - `expandTransactions` boolean — Whether or not to include transaction lines in the notification.
  - `expandPayments` boolean — Whether or not to include payment lines in the notification.
  - `subscribeTo` ApeEventResource[]
    - `name` string — Events to subscribe to. * order: `DELIVERED` * item: `SALES_RESTRICTION_UPDATED` - Business locations for this webhook must be specified [here](https://api-docs.lsk.lightspeed.app/operation/operation-apegetwebhookbusinesslocations). * order_api: `ONLINE_ORDER_READINESS` - Business locations for this webhook must be specified [here](https://api-docs.lsk.lightspeed.app/operation/operation-apegetwebhookbusinesslocations). The following are always sent: * Account: `CLOSED` and `CHECK_WAS_UPDATED`. * Order: `FAILURE`, `READY_FOR_PICKUP` and `CANCELLED`. * Payment: `SUCCESS` and `FAILURE`. * Order API: `READY` and `NOT_READY`.
    - `resource` 'order' | 'payment' | 'item' | 'order_api'

## Response `200`

Webhook

- ApeWebhookEndpoint
  - `endpointId` string, required — The unique endpoint ID, for example the integration name. Case sensitive.
  - `url` string, required — The URL which this endpoint points to.
  - `withBasicAuth` boolean — If basic auth should be used, defaults to false.
  - `username` string — The username for basic auth.
  - `password` string — The password for basic auth.
  - `provideAccount` boolean — Whether or not to include account info in the notification.
  - `expandTransactions` boolean — Whether or not to include transaction lines in the notification.
  - `expandPayments` boolean — Whether or not to include payment lines in the notification.
  - `subscribeTo` ApeEventResource[]
    - `name` string — Events to subscribe to. * order: `DELIVERED` * item: `SALES_RESTRICTION_UPDATED` - Business locations for this webhook must be specified [here](https://api-docs.lsk.lightspeed.app/operation/operation-apegetwebhookbusinesslocations). * order_api: `ONLINE_ORDER_READINESS` - Business locations for this webhook must be specified [here](https://api-docs.lsk.lightspeed.app/operation/operation-apegetwebhookbusinesslocations). The following are always sent: * Account: `CLOSED` and `CHECK_WAS_UPDATED`. * Order: `FAILURE`, `READY_FOR_PICKUP` and `CANCELLED`. * Payment: `SUCCESS` and `FAILURE`. * Order API: `READY` and `NOT_READY`.
    - `resource` 'order' | 'payment' | 'item' | 'order_api'

## Other responses

- `400` — Bad Request

---

[API](https://skmtc.net/lightspeed/apis/lightspeed-restaurant-k-series-api.md) · [All operations](https://skmtc.net/lightspeed/apis/lightspeed-restaurant-k-series-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightspeed/lightspeed-restaurant-k-series-api/revisions/0e481cddec74/schema)