API Reference

Create a Deep Link

What is this?

Deep links are a special URL format that will direct users to a section inside the Hover app. This capability removes any time lags or potential mistakes associated with manually opening and closing various apps and navigating to specific screens during your workflow. This is most commonly used to direct users straight to the capture screen for a new job.

Why would I use it?

If you wanted to send a user straight to the process of capturing photos for a Hover job, you could use a deep link in your CRM that takes people directly to that experience in the Hover app. Its a convenient way to direct users to specific places and experiences in the Hover app.

hihover://{company_name}/capture/identifier/{job_id}

Note that company_name is an arbitrary string. It is not mapped to your organization, so you can provide any valid, character escaped string.

Available Deep Links

Open Photo Capture

Directs a user to the capture screen for a job within the Hover app. Requires the job_id of the job you wish to navigate to.

hihover://{company_name}/capture/identifier/{job_id}

Open 3D Model

Directs a user to the 3D model for a job within the Hover app. Requires the job_id of the job you wish to navigate to.

hihover://{company_name}/3d/identifier/{job_id}

Open Property Details

Directs a user to the property details page for a job within the Hover app. Requires the job_id of the job you wish to navigate to.

hihover://{company_name}/details/identifier/{job_id}

Workflow

Using deep links to navigate to Hover jobs requires the job_id for the relevant job to be known at time of navigation. This constraint is typically solved by retaining the job_id that is returned when a job is created via API. Here is a simplified overview of how it works:

  1. Create a job using the API. This will return a job identifier, which is retained by your integration.
  2. User opens the 3rd party app and navigates to the record or project associated with the job_id you retained in step one.
  3. The user taps a button that invokes a deep link with a specific format. If you wanted to capture the property images for example, you could use the following format: hihover://{company_name}/capture/identifier/{job_id}.
  4. The deep link will launch the Hover app and ask the user to log in (if not already logged in).
  5. On success, the app will perform the action described in the deep link.