You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/mission-control/webhooks.mdx
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,11 +3,13 @@ title: "Webhooks"
3
3
description: "Kick off Cloud Agents from external events"
4
4
---
5
5
6
-
# Webhook
6
+
# Webhooks
7
7
8
8
## Overview
9
9
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.
11
13
12
14
## Quick Start
13
15
@@ -22,7 +24,7 @@ Navigate to **Settings → Webhooks** and click **Create Webhook**.
22
24
Fill in the required fields:
23
25
24
26
-**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
26
28
-**Repository**: Choose the repository where the agent will run
27
29
-**Advanced Settings (Optional)**:
28
30
-**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.
296
298
297
299
## Creating Agents for Webhooks
298
300
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:
302
302
303
303
```
304
304
{agent prompt}
305
305
306
306
{stringified webhook payload}
307
307
```
308
308
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
+
309
313
### Example: Bug Report Handler
310
314
311
315
Here's an agent designed to handle bug reports from webhooks:
0 commit comments