Skip to content

Start building

Integration · Analytics and data

AI agents for Heap

Send server-side events to Heap product analytics, identify users, set user and account properties, and delete a person's data, with the environment ID and an admin API key.

Actions
7
Read
1
Write
6

Actions

What your agents can do in Heap

7 actions. Each one is a tool your agents can call and a step your workflows can run.

Read 1

Look things up. Nothing changes.

  • Get a deletion request's status

    Reads whether a user deletion request is pending or complete.

Write 6

Create, change or send.

  • Track an event

    Records a custom event for one user from the server, like "Order Completed" with properties {"total": 49.99, "plan": "pro"}.

  • Track many events

    Records up to 1,000 events in one call, each with event, identity or user_id, and optional properties, timestamp and idempotency_key.

  • Identify a user

    Ties an anonymous Heap user (its user_id from the Heap SDK) to your identity for them, like an email, and moves the anonymous user's events to that identity.

  • Set user properties

    Sets properties on one identified user, like {"plan": "pro", "signup_date": "2026-01-15T00:00:00Z", "email": "jane@acme.com"} (write the built-in email in lower case).

  • Set account properties

    Sets properties on one account (a company your users belong to), like {"tier": "enterprise", "owner": "Sam Lee", "seats": 40}, for account analysis.

  • Delete users' dataDeletes data

    Asks Heap to delete up to 10,000 people and all their data across every environment of the account (for privacy requests), each given by identity or user_id.

A person can approve first

Any write action can be set to wait for a person's approval before it runs, so an agent asks before it changes anything. Actions that delete data ask first by default.

Connection

How it connects

Connect it once in the console, then give it to the agents and workflows that need it.

Sign-in details

Enter the sign-in details Heap gives you for its API.

What you enter

  • Environment ID (app ID)
  • API key

Settings

  • Data center

Kept safe

  • Credentials are stored encrypted with your organization's own keys.
  • They are opened only by the process that makes the call, at the moment it runs, and never go into a prompt or the browser.
  • Calls go only to the tool's own servers.

How we protect your data

Ideas

Ideas to start with

Starting points made only from the actions above. Mix them with any other tool your agents can use.

  • 01

    Ask about your Heap data

    Ask a question in plain words. The agent can get a deletion request's status in Heap, then answers with what it found.

  • 02

    Let an agent update Heap

    Have the agent track an event or track many events in Heap as part of a larger task. Turn on approval and a person signs off on each change first.

  • 03

    Share what it finds in Slack

    Give one agent Heap and Slack: it can get a deletion request's status in Heap and post a summary to a Slack channel in the same run.

FAQ

Heap and MyDeepAgents

Can MyDeepAgents connect to Heap?

Yes. The Heap connector has 7 actions: 1 reads and 6 make changes. Your agents can call them as tools, and your workflows can run them as steps.

How do I connect Heap?

Enter the sign-in details Heap gives you for its API. You'll need: Environment ID (app ID) and API key. The connection also asks for: Data center. Credentials are stored encrypted with your organization's own keys and are opened only at the moment of a call.

Can an agent change data in Heap without asking?

Only if you let it. Each of the 6 actions that change data can be set to wait for a person's approval before it runs, and the one that deletes data asks first by default.

Can I use Heap in workflows as well as agents?

Yes. Every Heap action also works as a step in a workflow, and the same connection serves your agents and your workflows.

Early access

Put Heap to work

Connect it in a few minutes, give an agent the actions it needs, and decide which changes wait for a person.