Skip to main content

Hotjar API Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a FlexFlow, DB-CDC, Spark ETL, or Replication data flow that sends data to a Hotjar API location.
hotjar_api.png

Hotjar API

Create a Hotjar API Destination​

  1. Click the + icon on the Nexset that will be sent to the Hotjar API destination, and select the Send to Destination option from the menu.

  2. Select the Hotjar API connector from the list of available destination connectors. Then, select the credential that will be used to connect to the Hotjar API organization, and click Next; or, create a new Hotjar API credential for use in this flow.

  3. In Nexla, Hotjar API destinations can be created using pre-built endpoint templates, which expedite destination setup for common Hotjar API endpoints. Each template is designed specifically for the corresponding Hotjar API endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    Hotjar API destinations can also be configured manually, allowing you to send data to Hotjar API endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Hotjar API endpoints. Each template is designed specifically for the corresponding Hotjar API endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

    User Lookup

    Perform a user lookup (with optional deletion)

    • Enter the organization's unique identifier in the Organization ID field. This ID can be found in the Sites & Organizations page next to the respective organization in your Hotjar account.
    • The endpoint uses POST requests to https://api.hotjar.io/v1/organizations/{organization_id}/user-lookup where {organization_id} is the Organization ID you provide. The endpoint URL is automatically constructed based on the Hotjar API base URL and the organization ID.
    • The endpoint sends data from your Nexset as the request body in JSON format. The request body is automatically formatted according to the schema fields and data mapping you configure. Each record in your Nexset will be sent as a JSON object containing the user lookup data.
    • Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to perform a user lookup. If you need to perform multiple user lookups, you can send multiple records, but each will be processed as a separate request.
    • This endpoint does not automatically create a data source to track the responses received from the Hotjar API after each call.

    The request body must be properly formatted JSON that matches the Hotjar API specification for user lookups. The endpoint requires token-based authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained using the OAuth2 client credentials flow with your Client ID and Client Secret. The Content-Type: application/json header is automatically included in requests. This endpoint can perform user lookups with optional deletion functionality. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about user lookups, including required fields, field names, and request formats, see the Hotjar API Reference documentation.

Configure Manually​

Hotjar API destinations can be manually configured to send data to any valid Hotjar API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Hotjar API destinations, such as destinations that use custom request headers, different HTTP methods, or custom data formatting.

Content Format​

  1. Select the format in which the Nexset data will be sent to the Hotjar API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The Hotjar API typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the Hotjar API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Hotjar API endpoints typically follow the pattern https://api.hotjar.io/v1/{endpoint_path}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires token-based authentication via the Authorization: Bearer {token} header, which is handled automatically by your credential configuration. The access token is obtained using the OAuth2 client credentials flow with your Client ID and Client Secret. For detailed information about Hotjar API endpoints and available APIs, see the Hotjar API Reference documentation.