Zapier API documentation

Authentication

Our api uses a simple "API Key-based authentication", this means your must include your API key for each request as a header.

You must obtain the API key for your account in: Settings > Plugins & integrations > Zapier. Enable Zapier integration and you will see your API key:

API key

When you have your API key you are ready to start using this API.

Triggers

New Portal Booking Trigger

This trigger will call your subscription hook whenever a new booking has been made in your booking portal.

This is the data the trigger will send as its payload:

{
  "bookingId": "xyz",
  "customerName": "John Doe",
  "customerPhone": "+1 555-555-5555",
  "customerEmail": "[email protected]",
  "start": "2010-11-12T13:00:00Z",
  "end": "2010-11-12T14:00:00Z",
  "activityName": "Back massage",
  "status": "PENDING"
}
Subscribe
Endpoint
POST https://app.lapsula.com/integration/zapier/webhook/new_portal_booking
Headers
{
  X-API-KEY: 'YOUR_API_KEY',
  Content-Type: 'application/json',
  Accept: 'application/json'
}
Body
{
  hookUrl: 'the_hook_you_want_to_subscribe'
}
Return statuses
  • 200Ok
  • 400Bad request
  • 401Unauthorized
  • 500Error
Unsubscribe
Endpoint
DELETE https://app.lapsula.com/integration/zapier/webhook/new_portal_booking
Headers
{
  X-API-KEY: 'YOUR_API_KEY'
}
Return statuses
  • 200Ok
  • 400Bad request
  • 401Unauthorized
  • 500Error
New Admin Booking Trigger

This trigger will call your subscription hook whenever a new booking has been made through your backoffice.

This is the data the trigger will send as its payload:

{
  "bookingId": "xyz",
  "customerName": "John Doe",
  "customerPhone": "+1 555-555-5555",
  "customerEmail": "[email protected]",
  "start": "2010-11-12T13:00:00Z",
  "end": "2010-11-12T14:00:00Z",
  "activityName": "Back massage",
  "status": "APPROVED"
}
Subscribe
Endpoint
POST https://app.lapsula.com/integration/zapier/webhook/new_admin_booking
Headers
{
  X-API-KEY: 'YOUR_API_KEY',
  Content-Type: 'application/json',
  Accept: 'application/json'
}
Body
{
  hookUrl: 'the_hook_you_want_to_subscribe'
}
Return statuses
  • 200Ok
  • 400Bad request
  • 401Unauthorized
  • 500Error
Unsubscribe
Endpoint
DELETE https://app.lapsula.com/integration/zapier/webhook/new_admin_booking
Headers
{
  X-API-KEY: 'YOUR_API_KEY'
}
Return statuses
  • 200Ok
  • 400Bad request
  • 401Unauthorized
  • 500Error
Booking Status Updated Trigger

This trigger will call your subscription hook whenever a booking status has been updated

This is the data the trigger will send as its payload:

{
  "bookingId": "clzi5z80p0000bolgq7q4ujhj",
  "status": "APPROVED"
}
Subscribe
Endpoint
POST https://app.lapsula.com/integration/zapier/webhook/booking_status_updated
Headers
{
  X-API-KEY: 'YOUR_API_KEY',
  Content-Type: 'application/json',
  Accept: 'application/json'
}
Body
{
  hookUrl: 'the_hook_you_want_to_subscribe'
}
Return statuses
  • 200Ok
  • 400Bad request
  • 401Unauthorized
  • 500Error
Unsubscribe
Endpoint
DELETE https://app.lapsula.com/integration/zapier/webhook/booking_status_updated
Headers
{
  X-API-KEY: 'YOUR_API_KEY'
}
Return statuses
  • 200Ok
  • 400Bad request
  • 401Unauthorized
  • 500Error
Booking Rescheduled Trigger

This trigger will call your subscription hook whenever a booking has been rescheduled

This is the data the trigger will send as its payload:

{
  "bookingId": "clzi5z80p0000bolgq7q4ujhj",
  "start": "2010-11-12T13:00:00Z",
  "end": "2010-11-12T14:00:00Z"
}
Subscribe
Endpoint
POST https://app.lapsula.com/integration/zapier/webhook/booking_rescheduled
Headers
{
  X-API-KEY: 'YOUR_API_KEY',
  Content-Type: 'application/json',
  Accept: 'application/json'
}
Body
{
  hookUrl: 'the_hook_you_want_to_subscribe'
}
Return statuses
  • 200Ok
  • 400Bad request
  • 401Unauthorized
  • 500Error
Unsubscribe
Endpoint
DELETE https://app.lapsula.com/integration/zapier/webhook/booking_rescheduled
Headers
{
  X-API-KEY: 'YOUR_API_KEY'
}
Return statuses
  • 200Ok
  • 400Bad request
  • 401Unauthorized
  • 500Error
Booking statuses
  • PENDINGThe booking needs to be approved in order to be effective
  • CALLOFFThe business (you) has called off the booking
  • CANCELLEDThe customer has cancelled the booking
  • DECLINEDThe booking has been declined by the business (you). This means the booking went from 'PENDING' to 'DECLINED'
  • APPROVEDThe booking is approved, this means the booking went from 'PENDING' to 'APPROVED', or the booking was directly created from the backoffice, or the booking had the 'Automatic' approval method set