Overview

To authenticate with Heap, you need:
  1. App ID - Your Heap application ID that identifies your application when making API requests.
  2. API Key - Your Heap API key that is used to generate an access token for authenticating API requests to Heap.
This guide will walk you through generating your API key within Heap.

Prerequisites:

  • You must have an account with Heap and admin permissions to generate and retrieve the API key.

Instructions:

Step 1: Generating Your API Key and App ID

  1. Log in to your Heap account.
  2. Navigate to Account > Manage > Privacy & Security.
  3. Scroll to the bottom of the page, where you will find your App ID.
  4. Click on Generate new Key to generate a new API Key. Your key will be displayed.

Step 2: Enter credentials in the Connect UI

Once you have your API Key and App ID:
  1. Open the form where you need to authenticate with Heap.
  2. Enter both API Key and App ID in their designated fields.
  3. Submit the form, and you should be successfully authenticated.
You are now connected to Heap.