Agent Setup Links
Setup Links are time-limited URLs that serve agent configuration instructions in a secure, self-destructing format. They provide a safer alternative to directly sharing API tokens.
How It Works
- Go to Agents in your Broadcast sidebar
- Click Generate Setup Link. The link is created for the channel’s oldest API token, which is the one listed first on the Agents page
- A unique URL is created (e.g.,
https://your-instance.com/agents/setup/abc123...) - Share the URL with your AI agent (paste it into the chat)
- The agent fetches the URL and self-configures with the correct credentials
What the Agent Receives
When an agent accesses the setup link, it receives a Markdown document containing:
- Your Broadcast instance URL
- The associated API token
- Token permissions
- Channel name and configuration
- CLI installation instructions
- Quick-start commands
Security
Setup Links are designed to be safe to share in chat conversations:
| Property | Default |
|---|---|
| Expiry | 1 hour after creation |
| Max accesses | 3 times |
| Slug format | 256-bit cryptographically random |
Once a setup link expires or reaches its access limit, it returns a 404 response. Expired links are automatically cleaned up.
Note
A setup link carries its API token’s secret and inherits that token’s permissions. Generate Setup Link always uses the channel’s oldest API token, listed first on the Agents page, so make sure that token has only the permissions your agent needs. To give an agent narrower access, reduce that token’s permissions before generating the link.
Who can create and delete links
Because a link publishes a token’s secret to whoever holds the URL, creating or deleting one needs the Create and manage API tokens permission on the channel (sudo users always have it). View API tokens alone shows the Agents page but cannot publish a token. A link always belongs to the channel you are working in: you cannot generate one for another channel’s token, or delete another channel’s links.
Managing Setup Links
Generating a Link
From the Agents dashboard, click Generate Setup Link. The link is displayed with a copy button for easy sharing, and stays listed until it expires.
Revoking a Link
To immediately invalidate a setup link before it expires, click the Delete button next to it on the Agents dashboard.
Example: Onboarding Claude Code
- Generate a setup link from the Agents dashboard
- In Claude Code, paste:
Please configure yourself to manage my Broadcast email marketing. Here's the setup link: https://your-instance.com/agents/setup/abc123... - Claude Code fetches the link, reads the configuration, and is ready to manage your email marketing
Example: Introduction Message
After generating a setup link, you’ll see a clipboard-ready introduction message:
I use Broadcast for email marketing. Here's how to connect: Setup: https://your-instance.com/agents/setup/abc123... This link expires in 1 hour. Fetch it to get your API credentials and available commands.
