How to enable SpringboardVR

To enable SpringboardVR follow the steps outlined here.

How to enable:

Follow the steps below to enable the SpringboardVRintegration in a client’s Dashboard. All we need from the client in order to initiate this process is their confirmation that they are working with SpringboardVR and would like to connect with FareHarbor. Clients should be directing this request to FareHarbor Support, but setting this up is easy and anyone can do it.

Setup:

1. Go to the client’s Dashboard and create a new User called “SpringboardVR.” Give this user the highest permission group available.

2. From the “SpringboardVR” user’s settings, navigate to the API Keys tab. Add a new API Key, and name it “SpringboardVR Webhook.”

3. Click Edit on that new API Key. On this Edit page, you’ll see a blank field for a Webhook URL. Paste the following URL into that field, and then hit Save. SpringboardVR’s Webhook URL will be the same for every FareHarbor client: https://api.springboardvr.com/v1/webhook/fareharbor

4. Once this is done, send an email back to the client with SpringboardVRCustomer Success cc’d (fareharbor@springboardvr.com) to confirm the integration has been enabled on FareHarbor’s end. In this email, you must also indicate the client’s FareHarbor shortname. The shortname is how SpringboardVR will know how to identify the client’s bookings – so it is important to share that with them.

5. Now that the webhook is enabled, you must trigger it for the existing bookings in that Dashboard. The webhook must be enabled first before this next step is taken. Please follow the steps in the next section.

Triggering the webhook for existing bookings

1. Run a report to see existing bookings for future dates

Run a Detailed Bookings report in the charter company’s Dashboard to see all bookings for future availability dates. It is best to select a custom date range starting with today’s date and ending with 2 years from that date (or as far out as that company has future bookings.)

2. Initiating the webhook for each future bookings

The Business Intelligence SpringboardVR script can automate webhooks for companies with 100 or more future bookings (if there are fewer than 100 future bookings, follow these steps instead).

To send an automation request to the Business Intelligence team:

1. Click the “Share” button within your report, and copy the unique report URL

   

2. Paste that report URL into a FareHarbor Automation submission request form

3. In the “Select Automation Type” field, select “Wherewolf Update” (That’s just how BI has named it, this will still work for other webhook requests.”
4. In the “Date automation can start” field, enter today’s date
5. In the “Maximum date of completion” field, enter 5pm of the next business day
6. In the “Link to FareHarbor report of bookings” field, paste the URL of your future bookings report
7. Reference this help page for more information about submitting this type of form

Manually initiating the webhook when there are fewer than 100 future reservations

When there are fewer than 100 future reservations, the webhook can be initiated by opening each booking in the report and “touching” the booking:

1. Open the booking and click Edit contact
2. Remove and re-add the contact information by cutting and pasting

3. Save your changes to trigger the webhook

   Watch video example

3. Final steps

1. The Business Intelligence Team will run that report through the SpringboardVR script they designed (it’s the Wherewolf script since the process of retriggering the webhook is the same).
2. Once completed, the BI team will post in the #fareharbor-automation Slack room, confirming the SpringboardVR script has been completed.
3. At that point, you may close the ticket! In the internal note, please write the date that the SpringboardVR script was completed.

• Check to see if the client’s dashboard has a “Springboard” User, and check that the Webhook URL in their API Key matches the SpringboardVR Webhook URL pasted above.
• Webhook activity will also be shown within the history of each individual booking in that Dashboard. For example, after a booking is created, the next event in that booking history should read: External API Booking Webhook request succeeded (SpringboardVR Webhook). Note: All webhook activities in a booking are visible to Admins only.