---
title: "Onboarding notification"
method: POST
path: "reservation-serviceReservation onboarding notification"
tags: ["Reservations for Platforms"]
---

# Onboarding notification

`POST reservation-serviceReservation onboarding notification` (webhook)

These notifications are sent to the URL provided in the[`onboardingWebhookUrl` field](https://api-docs.lsk.lightspeed.app/operation/operation-reservation-servicesetbyplatformcode#operation-reservation-servicesetbyplatformcode-body-application-json-onboardingwebhookurl).

## Payload

- ReservationServiceOnboardingWebhook
  - `businessInformation` object, required
    - `businessLocationId` integer, required — The unique identifier of the business location.
    - `city` string — The city of the company.
    - `country` string — The country code of the company.
    - `name` string, required — The company name in Lightspeed Backoffice.
    - `state` string — The state of the company.
    - `street1` string — The primary street of the company.
    - `street2` string — The secondary street of the company.
    - `zip` string — The zip code of the company.
  - `epochSecondsDeadlineUtc` integer, required — The epoch time in seconds until which the onboarding process remains active.
  - `onboardingId` string, required — The unique identifier of the integration process that has started onboarding.
  - `platformCode` string, required — The unique code assigned to the reservation platform.
  - `platformRestaurantReference` string, required — The alias for a restaurant on an external platform, such as its unique identifier or local unique name.

## Acknowledgement `200`

Your server returns this code if it accepts the callback.

---

[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/versions/fd2e31cf57dd/schema)