How to enable SynthesisVR

1. From the client’s dashboard, go to Settings > Users & Permissions > and create a new user called “SynthesisVR”. Give this user the highest permission group available.

   

2. Within the settings of that new “SynthesisVR” user, navigate to the API Keys tab. Add a new API Key, and name it “SynthesisVR Webhook”. Here, you will also find the API key you will have to give back to the client or SynthesisVR.

3. Click Edit on that new API Key. On this Edit page, you’ll see a blank field for a Webhook URL. Paste the webhook URL you received by the client or SynthesisVR into that field, selecting “Bookings only” and check the box “Updated Bookings”, and then hit Save.

   The Webhook URL is essentially the address where Swell will receive the client’s booking details. Once this URL is plugged in, the webhook is immediately activated, and Swell will begin receiving the booking details for any and every booking created on this Dashboard, in real-time.

4. Once this is done, please tag @software-partnerships in #softwarepartnerships to confirm that the integration has been enabled, as they will have to add the specific dashboard to the list of SynthesisVRs’ integrations. Also, reply to the client’s email, ccing SynthesisVR support, confirming that the integration has been enabled on the FareHarbor end and giving them the API key they requested. The API key can be found under User & Permissions, under the SynthesisVR User in the API keys tab.

The webhook will automatically send Synthesis every booking moving forward, but action is still required in FareHarbor to send Synthesis any existing bookings for future dates. Here are the required next steps to ensure that we send Synthesis every future booking that they need in their system.

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 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 Webhook Update.
   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.

      Reference this help page for more information about submitting this type of form.

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.

• Check to see if the client’s Dashboard has a “SynthesisVR” User, and check that the Webhook URL in their API key has a Webhook URL.
• 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 (SynthesisVR: synthesis).

Note: All webhook activities in a booking are visible to Admins only.

1. Go into the dashboard’s settings and select Users & Permissions.
2. Select SynthesisVR Webhook > Edit.
3. Select API Keys > Edit.
4. Select Delete API Key.
5. Once the API Key has been deleted, deactivate the SynthesisVR Webhook user:
   1. Within the SynthesisVR Webhook user, select Account.
   2. Select Permissions.
   3. Update user status to deactivated.
   4. Save.