Skip to content

Commit 22cb6bd

Browse files
Tom GotsmanTom Gotsman
authored andcommitted
webhooks
1 parent b8c1466 commit 22cb6bd

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

docs/ai_builder/webhooks.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# Webhooks
2+
3+
Webhooks allow your app to **send data to external services** in real time. You provide the AI Builder with a **webhook URL** created in another platform, and it can **automatically send payloads** to that URL when workflows are triggered.
4+
5+
This is a simple and powerful way to integrate with services that support incoming webhooks, even if there’s no first-class integration.
6+
7+
## What You Can Do
8+
9+
With outgoing webhooks, your app can:
10+
11+
* **Send structured payloads** to any service that supports incoming webhooks (e.g., Slack, Zapier, Make, Discord).
12+
* **Trigger external workflows** when events happen in your app.
13+
* **Push real-time updates** to third-party systems without writing custom backend code.
14+
* Chain webhook calls with other integrations or AI actions.
15+
16+
## Step 1: Create a Webhook in the External Service
17+
18+
1. Go to the external service you want to connect (e.g., Slack, Zapier, Discord, Make).
19+
2. Create a new **incoming webhook** in that service.
20+
3. Copy the **webhook URL** it provides.
21+
22+
23+
## Step 2: Add the Webhook URL to AI Builder
24+
25+
1. In the AI Builder chat paste the **webhook URL** you created in the external service.
26+
2. You can then instruct the AI to **send data to this URL** whenever a workflow is triggered.
27+
3. Optionally define the **payload structure** (e.g., JSON body) and when it should be sent.
28+
29+
> 💡 Example: “Send user signup data to this webhook whenever a user signs up.”
30+
31+
## Step 3: Sending Payloads
32+
33+
* The AI Builder will write the code to send a `POST` request to the webhook URL with the payload you define.
34+
* The payload can include **dynamic data** from your app — such as user info, state variables, or model outputs.
35+
* You can trigger these webhook calls from buttons, events, workflows, or automations.
36+
37+
38+
## Step 4: Notes
39+
40+
* **Security:** Only use webhook URLs from trusted services — they will receive your data as-is.
41+
* **Formatting:** Make sure the payload matches the expected format of the external service.
42+
* **Chaining:** You can use multiple webhooks or combine them with other integrations.
43+
* **Use cases:** Slack alerts, CRM updates, triggering automations in Zapier or Make, notifying custom systems.
44+

0 commit comments

Comments
 (0)