Create or Update Platform Profile
Create or update details for external reservation platform.
Path parameters
-
platform-code string Required
The unique code assigned to the reservation platform.
Maximum length is
11
. Format should match the following pattern:[a-zA-Z0-9_-]+
.
Body
-
baseUrl string(uri)
The base URL of the external platform (optional).
-
orderWebhookUrl string
The URL where order notifications will be sent.
Required fororder
notificationTypes.
See Get Sample Order Update. -
integrationWebhookUrl string
The URL where notifications for activation or deactivation of the customer's integration will be sent.
Required forintegration
notificationTypes.
See Get Sample Integration notification. -
onboardingWebhookUrl string
The URL where notifications for the customer's integration onboarding will be sent.
Required foronboarding
notificationTypes.
See Get Sample Onboarding notification. -
errorsWebhookUrl string
The URL where notifications for any issues will be sent.
Required forerror
notificationTypes.
See Get Sample Error notification -
notificationTypes array
The events that trigger a notification.
Values are
ORDER_OPENED
,ORDER_UPDATED
,ORDER_CLOSED
,ONBOARDING_STARTED
,INTEGRATION_ACTIVATED
,INTEGRATION_DEACTIVATED
, orERROR
. -
displayName string Required
The official platform name that will be displayed.
-
depositSupported boolean
Whether or not the platform supports deposits.
-
ownNotificationsOnly boolean
When
true
, notifications will only be sent for orders linked to the reservation platform. -
webhookAuthType string Required
The type of authentication used by the webhook.
Values are
BASIC_AUTH
,BEARER_TOKEN
,API_KEYS
,OAUTH2
, orNONE
. -
webhookAuthDetails object Required
The authentication credentials to be sent with the webhook notifications.
curl \
-X POST https://api.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/profile \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"baseUrl":"https://my.platform/api","orderWebhookUrl":"https://my.platform/api/webhook/orders","integrationWebhookUrl":"https://my.platform/api/webhook/integrations","onboardingWebhookUrl":"https://my.platform/api/webhook/onboarding","errorsWebhookUrl":"https://my.platform/api/webhook/errors","notificationTypes":["ORDER_CLOSED"],"displayName":"My Platform","depositSupported":true,"ownNotificationsOnly":true,"webhookAuthType":"OAUTH2","webhookAuthDetails":{"basic":{"username":"LightspeedKSeries","password":"Example-Password"},"bearer":{"token":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...","tokenTtl":"2025-01-01T00:00:00"},"apiKeys":{"headers":{"X-API-ID":"Example-x-api-id","X-API-SECRET":"Example-x-api-secret"},"parameters":{"key":"string"}},"oauth2":{"clientId":"LightspeedKSeries","clientSecret":"Example-Client-Secret","clientName":"LightspeedKSeries","clientAuthorizationMethod":"CLIENT_SECRET_BASIC","authorizationGrantType":"CLIENT_CREDENTIALS","scopes":["webhooks-api"],"providerTokenUri":"https://my.platform/emitter/token","providerJwkSetUri":"https://my.platform/public-keys"}}}'
{
"baseUrl": "https://my.platform/api",
"orderWebhookUrl": "https://my.platform/api/webhook/orders",
"integrationWebhookUrl": "https://my.platform/api/webhook/integrations",
"onboardingWebhookUrl": "https://my.platform/api/webhook/onboarding",
"errorsWebhookUrl": "https://my.platform/api/webhook/errors",
"notificationTypes": [
"ORDER_CLOSED"
],
"displayName": "My Platform",
"depositSupported": true,
"ownNotificationsOnly": true,
"webhookAuthType": "OAUTH2",
"webhookAuthDetails": {
"basic": {
"username": "LightspeedKSeries",
"password": "Example-Password"
},
"bearer": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"tokenTtl": "2025-01-01T00:00:00"
},
"apiKeys": {
"headers": {
"X-API-ID": "Example-x-api-id",
"X-API-SECRET": "Example-x-api-secret"
},
"parameters": {
"key": "string"
}
},
"oauth2": {
"clientId": "LightspeedKSeries",
"clientSecret": "Example-Client-Secret",
"clientName": "LightspeedKSeries",
"clientAuthorizationMethod": "CLIENT_SECRET_BASIC",
"authorizationGrantType": "CLIENT_CREDENTIALS",
"scopes": [
"webhooks-api"
],
"providerTokenUri": "https://my.platform/emitter/token",
"providerJwkSetUri": "https://my.platform/public-keys"
}
}
}