← All integrations

Heyy MCP server

15 operations0 webhooks

Customer messaging over WhatsApp, SMS and Instagram from Heyy - search and create contacts, define custom attributes and labels, and manage the webhook endpoints that deliver message events.

Use Heyy in Claude, ChatGPT, Cursor or another MCP client

Connect Heyy once in Corsair, then add one MCP address to your agent.

Connect Heyy
Setup steps for Claude, ChatGPT, Cursor and Claude Code

Building your own app on the Corsair SDK? Get API keys

Try Heyy with your agent

Connect Heyy, then paste this into Claude, ChatGPT or Cursor. For ideas from other apps, see the use cases.

Using Corsair, show me what you can do in Heyy on my account, then run one read-only example and show me the result.

Runs once, when you ask

Heyy tools and triggers

Tools are what your agent can do in Heyy through Corsair's MCP server. Triggers are the Heyy events a routine can start from.

Api Webhooks

  • CreateWrite

    Register an HTTPS endpoint for message events on the channels named in each event; Heyy then POSTs every matching message, with its content and sender, to that URL

    apiWebhooks.create

  • RemoveDestructive

    Delete a webhook endpoint by id; Heyy stops delivering to it immediately

    apiWebhooks.remove

  • SearchRead-only

    List the registered webhook endpoints with their URL, status and subscribed events

    apiWebhooks.search

  • UpdateWrite

    Change a webhook's URL or events, or pause deliveries by setting it inactive

    apiWebhooks.update

Attributes

  • CreateWrite

    Define a custom contact attribute: text, number, select or date, with the options a select needs and where it appears

    attributes.create

  • RemoveDestructive

    Delete a custom contact attribute by id; the values contacts had for it are gone and cannot be restored. An id that does not exist fails with 404 attribute_not_found

    attributes.remove

  • SearchRead-only

    Search the custom contact attributes defined on the workspace, with their type, options and where they appear in Heyy

    attributes.search

Labels

  • CreateWrite

    Create a label with a name and a hex colour

    labels.create

  • RemoveDestructive

    Delete a label by id; it is detached from every contact that carried it

    labels.remove

  • SearchRead-only

    Search the labels used to group contacts, with their colours

    labels.search

Contacts

  • CreateWrite

    Create a contact with a name, phone number or email, attach labels by id and set custom attribute values

    contacts.create

  • SearchRead-only

    Search contacts with a structured filter, free-text search, sorting and paging; returns the matched contacts with their labels and attribute values

    contacts.search

Connect Heyy to Claude, ChatGPT or Cursor

  1. 1

    Connect Heyy in Corsair

    Add your Heyy API key once in Corsair. Corsair stores the credential encrypted and makes the Heyy API calls for your agent, so it never goes into a prompt or a config file. Connect Heyy

    If your link lets the agent add apps, you can skip this: it gives you a sign-in link the first time it needs Heyy. On a ChatGPT personal plan, connect Heyy here first.

  2. 2

    Add Corsair's MCP server to your agent

    Every client uses the same address:

    https://mcp.corsair.dev/mcp
    Open Customize → Connectors → Add custom connector, paste the address, then select Connect.

    Codex, Gemini CLI, VS Code, Zed and other clients with OAuth sign-in work the same way. Clients without it, such as GitHub Copilot's coding agent, use a link's own address and an API key. Setup for every client

  3. 3

    Sign in and choose what needs your approval

    Your client opens Corsair to sign in. Pick a link: the apps your agent can use and a mode that decides what it may do without asking. In the default Cautious mode, Heyy's read and write operations run right away and its 3 destructive operations wait for your approval. Strict mode asks before every write and refuses destructive operations, and Read mode allows reads only.

FAQ

Install corsair and @corsair-dev/heyy, add the Heyy plugin, and connect with an API key. Then call methods like corsair.heyy.api.apiWebhooks.create() from your app. Corsair keeps each tenant isolated.

Yes. Heyy requires an API key from your Heyy account or developer dashboard. Create credentials with access that matches what you automate, then paste them into Corsair or connect through managed auth in Hub.

Yes. One Corsair client can hit Heyy, GitHub, Notion, Stripe, and the rest. Trigger Heyy from a webhook, push updates to Slack, or chain actions across plugins. Same tenant context across integrations, plain TypeScript.

Teams use Corsair for customer messaging over WhatsApp, SMS and Instagram from Heyy - search and create contacts, define custom attributes and labels, and manage the webhook endpoints that deliver message events. Common builds include sync jobs, admin tooling, and agents that call Heyy APIs from your backend.

The SDK is open source. Self-host and you pay Corsair nothing for the integration layer. Hub bills for hosted auth and execution, not per Heyy API call. Hub has a generous free tier. For hobby projects you can probably run the whole thing on free. Paid plans start to matter with more tenants or heavier traffic.

We maintain @corsair-dev/heyy in the open repo. When Heyy ships API changes, upgrade the package. Your call sites stay typed. You should not need to rewrite the integration layer each time.

No. Corsair does not read your Heyy data or hold individual access credentials. Credentials stay in your database. API calls run on your instance. We do not store Heyy data on your behalf.

Yes. Add https://mcp.corsair.dev/mcp as a custom connector or MCP server in Claude, ChatGPT, Cursor, VS Code, Claude Code, Codex or any client that supports remote MCP servers with OAuth sign-in, then sign in to Corsair. On ChatGPT personal plans, custom servers currently get read tools only.

Yes. Put Heyy on a link in Strict mode and every write waits for your approval, while destructive actions are refused. The default Cautious mode asks only before the 3 destructive Heyy operations. You can change a link's mode at hub.corsair.dev/me.