> ## Documentation Index
> Fetch the complete documentation index at: https://docs.boostgpt.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Plunk

> Contacts, segments and campaigns on Plunk, hosted or your own server. Mira adds signups and drafts campaigns for you to approve.

Contacts, segments and campaigns on Plunk, hosted or your own server. Mira adds signups and drafts campaigns for you to approve.

## Connecting

In the dashboard, open **Connectors**, find Plunk and press **Connect**. The key you enter is checked against Plunk before anything is saved, so a key that is refused never becomes a connection that fails later.

### What you will need

| Field | What it is |
| - | - |
| API address | Leave blank for Plunk's hosted service, or enter your own Plunk API address |
| Secret key | Project settings → API keys → secret key (sk\_…) |
| Public key | Project settings → API keys → public key (pk\_…). Only needed to start workflows with `track_event`: Plunk records events with this key |

## What your AI teammate can do with it

| Tool | What it does |
| - | - |
| `add_subscriber` | Add a contact, or update one, as subscribed |
| `track_event` | Record an event on a contact, creating the contact if it is new. Starts any Plunk workflow that listens for that event, such as a welcome sequence. |
| `list_contacts` | Contacts; search by email |
| `get_contact` | One contact |
| `list_segments` | Segments, with member counts |
| `list_campaigns` | Campaigns, newest first |
| `get_campaign` | One campaign with its counts |
| `create_campaign` | Save a new campaign as a draft. It is never sent from here. |
| `update_campaign` | Change a draft campaign |
| `send_campaign` | Send a campaign now, or at scheduledFor |
| `get_campaign_stats` | Sent, opened, clicked and bounced counts for a campaign |

## Useful resources

* [Plunk API documentation](https://docs.useplunk.com/api-reference/overview)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.