Skip to content

Commit bb47ae2

Browse files
committed
wip: webhooks docs
1 parent 67ceda2 commit bb47ae2

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/mission-control/webhooks.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@ title: "Webhooks"
33
description: "Kick off Cloud Agents from external events"
44
---
55

6-
# Webhook
6+
# Webhooks
77

88
## Overview
99

10-
Webhooks allow you to trigger Background Agents automatically when external events occur. When a webhook receives data, it kicks off an agent session with the webhook payload appended to the prompt, executing your chosen agent in a specified repository.
10+
Webhooks are a type of Workflow Trigger which allow you to automatically kick off custom Cloud Agents when external events occur.
11+
12+
You can configure which Agent to run when your webhook receives data, and in which repository. The event payload (POST request body) will be appended to the Agent's prompt.
1113

1214
## Quick Start
1315

@@ -22,7 +24,7 @@ Navigate to **Settings → Webhooks** and click **Create Webhook**.
2224
Fill in the required fields:
2325

2426
- **Name**: A descriptive name for your webhook (e.g., "Zapier Bug Reports")
25-
- **Agent**: Select which agent to kick off when triggered
27+
- **Agent**: Select which Agent to kick off when triggered
2628
- **Repository**: Choose the repository where the agent will run
2729
- **Advanced Settings (Optional)**:
2830
- **Secret Header Name**: Custom HTTP header for authentication (e.g., `X-Webhook-Secret`)
@@ -296,16 +298,18 @@ Any valid JSON payload. This will appended to the Agent's prompt.
296298

297299
## Creating Agents for Webhooks
298300

299-
When a webhook triggers an agent, the incoming JSON payload is stringified and appended to your agent's prompt. Design your agent prompts to handle this structured data.
300-
301-
Agent files consist of YAML frontmatter and a markdown prompt. When triggered, the final prompt becomes:
301+
When a webhook triggers an agent, the incoming JSON payload is stringified and appended to your agent's prompt like this:
302302

303303
```
304304
{agent prompt}
305305
306306
{stringified webhook payload}
307307
```
308308

309+
Design your agent prompts to prepend and handle this structured data.
310+
311+
Below are some example webhook data and corresponding Agent prompts:
312+
309313
### Example: Bug Report Handler
310314

311315
Here's an agent designed to handle bug reports from webhooks:

0 commit comments

Comments
 (0)