Integration Guide
Thank you for integrating with FreeFallFilms. Hopefully the API documentation is helpful, but if you have any questions, please contact me and I'll be delighted to help.
The API is fairly extensive, but basic integration is quite simple. I've described what you might want to do for a Level 1, 2, and 3 integration below.
Most integrations are Level 1 only. This will provide an excellent user experience - it's perfectly reasonable to stop here!
Level 1: Provide Booking Information
All we really need is details of your customers on the day that they are jumping.
We provide a batch endpoint for you to send updates, or you can send updates individually.
You should send updates when there are significant changes, for example:
- New bookings
- Changes to customer field
- Change to camera product
This will enable you to manage almost everything exactly as before in your current system.
The most important information is
- Name
- Mobile
- Camera Product
Providing the following date/time info allows FreeFallFilms to give much better reporting.
jump_scheduled_atjump_manifested_atjump_performed_at(most important!)
You can access the FreeFallFilms web interface for specific changes or to check status by exception.
If you wish, you can use the ID and the link from created bookings to provide easy links from your system to FreeFallFilms and to the customer page. See URL Generation for details.
Level 2: Sync Staff Information
You probably have your staff information in your system - specifically Videographers and Tandem Instructors
The Filmers endpoint provides a way for you to sync that across.
This allows you to provide your own IDs to the system and limit duplication of data.
Level 3: Financial Integration
When additional sales or changes are made on FreeFallFilms, it is now possible to sync those back to your system.
We have a webhook system which can inform you when there are changes. You can look at additional entities in the booking show record, such as Jump and Finance Events, to see details on what has changed and what sales have taken place.