Heap

undefined

Detail	Value
Category	Analytics
Base URL	https://heapanalytics.com/api
Authentication	API Key
Endpoints	5
Connector key	heap

Using Heap in a workflow

1. Go to Connections and click New Connection.
2. Pick Heap from the marketplace.
3. Enter your credentials (see Authentication above for what's expected).
4. In a workflow, drop an API Call node and select this connection.
5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints

Endpoint	Summary
GET	Track
GET	User Properties
GET	Account Properties
GET	Identify
GET	Delete User

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET

Track

Detail	Value
Operation ID	track_0
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Heap connection from the Connection dropdown.
3. In the Operation dropdown, select track_0.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Heap API reference.

GET

User Properties

Detail	Value
Operation ID	user_properties_1
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Heap connection from the Connection dropdown.
3. In the Operation dropdown, select user_properties_1.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Heap API reference.

GET

Account Properties

Detail	Value
Operation ID	account_properties_2
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Heap connection from the Connection dropdown.
3. In the Operation dropdown, select account_properties_2.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Heap API reference.

GET

Identify

Detail	Value
Operation ID	identify_3
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Heap connection from the Connection dropdown.
3. In the Operation dropdown, select identify_3.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Heap API reference.

GET

Delete User

Detail	Value
Operation ID	delete_user_4
Method	GET
Path	``

Parameters

No parameters.

Using this endpoint in a workflow

1. Add an API Call node to your workflow.
2. Pick your Heap connection from the Connection dropdown.
3. In the Operation dropdown, select delete_user_4.
4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Heap API reference.