Developers
Changelog
What changed in the BookingNinja Apps contract, newest first.
19 November 2026: Contract v1
The first version of the BookingNinja Apps contract. Every file is under /developers/contract/v1/.
What v1 contains
- The manifest. Name, addresses, scopes, extension points, catalogue attributes, image delivery, settings for the venue and for each session, and a directory listing.
- What BookingNinja calls on your app.
catalogue,guest-step,availability,collection,holds,holds/confirm,holds/release,settings/options,settings/validate,blocks,actionsandevents. Every call is signed. - What your app calls on BookingNinja.
oauth/tokento connect, theninstallation,bookings/{ref},bookings/{ref}/notes,bookings/{ref}/alerts,bookings/{ref}/data,catalogue/changedandblocks/refresh, with a bearer token. - Scopes.
bookings:read,bookings:write_notes,bookings:alertandguests:read. - Events.
booking.confirmed,booking.updated,booking.cancelled,booking.checked_in,booking.completed,booking.no_show,installation.settings_updatedandinstallation.uninstalled. - Guest step blocks.
collection,fields,options,quantities,plan,notice,text,hero,gallery,steps,details,faq,table,meter,linksanddivider. A guest summary can adddetails,steps,codeandlinks. - Staff blocks.
badge,chip,text,key_value,image_list,actions,alert,stat,meter,timeline,table,tags,people,checklist,gallery,codeandlinks, in three slots:gantt_bar,list_rowanddrawer. - Fields. Fourteen field types, used by settings, guest forms and staff buttons.
- Collections that BookingNinja searches on a synced catalogue, or that your app runs itself.
- Alerts that go through the venue's own notification triggers.
Compatibility
BookingNinja has not published a compatibility or deprecation policy for v1 yet, and there is no date for a v2. This is what the platform does today:
- A guest block type that BookingNinja does not know is left out, and the rest of the step is kept.
- A field that is no longer used is still accepted and ignored. Two exist:
search.modeon a collection block, andvalid_for_secondsin anavailabilityreply. - A change to an approved app's manifest waits for review. That is a rule about your app, not about the contract.
Until a policy is written, do not assume more than that.