How to Enable Tomis

1. From the client’s Dashboard, go to Settings > Users & Permissions and create a new user called “Tomis Webhook API”. Give this user API read only permission.

   • If there is no API read only User permission go to Step 4. If there was, go to Step 5.

     

2. Within the settings of that new “Tomis Webhook API” user, navigate to the API Keys tab. Add a new API Key, and name it “Tomis API”.

3. Go to the Webhook tab and select Add New webhook. You will name it “Tomis Webhook”. Paste the following URL into that field, selecting “Bookings only” and check ALL the box (New bookings, Updated bookings & Canceled bookings), and then hit Save. Tomis’s Webhook URL will be the same for every FareHarbor client: https://app.tomis.tech/api/fareharbor/booking/

   • The Webhook URL is essentially the address where Tomis will receive the client’s booking details. Once this URL is plugged in, the webhook is immediately activated, and Tomis will begin receiving the booking details for any and every booking created on this Dashboard, in real-time.
4. Go to Settings > Users & Permissions > Permission groups. Then select a user permission and duplicate that.
   • Once duplicated, we need to rename this user to “API Read Only” and make sure the check boxes are the same as these ones. Click Save.
   • Add this permission to the “Tomis Webhook API” user.

5. Next, we will need to copy the API Key and paste it in this Google Doc. Go to #softwarepartnerships and use the workflow to notify the team that Tomis has been integrated on the dashboard. Once they CONFIRM, this step is complete.

6. Once this is done, follow the Triggering the webhook steps below.

7. Please tag @software-partnerships in #softwarepartnerships to let us know that the TOMIS integration has been set up and that you have taken all the steps above.
8. If you have finished with all the above steps, let Tomis know you have completed the integration.

The webhook will automatically send Tomis every booking moving forward, but action is still required in FareHarbor to send Tomis any existing bookings for future dates. Here are the required next steps to ensure that we send Tomis 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.
   7. 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.

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

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 Tomis Webhook > Edit.
3. Select API Keys > Edit.
4. Select Delete API Key.
5. Once the API Key has been deleted, deactivate the Tomis Webhook user:
   1. Within the Tomis Webhook user, select Account.
   2. Select Permissions.
   3. Update user status to deactivated.
   4. Save.