Install Hawk How to set up Hawk on your website

Add a Site
The Hawk dashboard before any sites have been added
The Hawk dashboard before any sites have been added

To install Hawk on a new site, click the Add Site button.

Name & Domain
Install Hawk: Step 1 of the Add Site wizard
Install Hawk: Step 1 of the Add Site wizard

Enter the name and domain of your site.

Settings
Install Hawk: Step 2 of the Add Site wizard
Install Hawk: Step 2 of the Add Site wizard

Reporting

Choose how you want reports sent to you, and what events you want to be reported. Hawk can report:

  • Console Logs
  • Network Errors
  • Promise Rejections
  • Script Errors

Choose whether to receive notifications by email. Emails are sent to the address you used to sign up for Hawk.
You can also choose whether to collect IP Address and Location data on your users. You may want to consider what privacy laws you may be subject to. For more information, see here.

Sensitive Data

For security reasons, Hawk does not send you your customer’s sensitive information. Certain values are ignored by default (such as any <input type="password">), but others need to be specified in the Sensitive Data section of this page. See here for specifics.

Integrations

You can also set up this site to make use of Hawk’s Slack or Trello integrations here.

Identify Your Users
Install Hawk: Step 3 of the Add Site wizard
Install Hawk: Step 3 of the Add Site wizard

Hawk can attempt to identify users that sign in to your site (if that’s one of your site’s features!). This information will be included in error reports. You can enable this by explicitly calling a function in Javascript, or by setting up automatic user identification.

More technical details are available here.

Add the Snippet
Install Hawk: Step 4 of the Add Site wizard
Install Hawk: Step 4 of the Add Site wizard

Copy the line of code into your site’s html, preferably at the end of the body element. (That is, the line above </body>.) This screen will display a message when it has successfully communicated with the snippet on your site.

For the technical details of what the Hawk snippet is doing under the hood, refer to Technical Details

If you’re having trouble getting Hawk set up, see our troubleshooting instructions, or contact us here.


Did you find this article helpful?