Skip to content

Commit 6041efe

Browse files
committed
Add event payload samples
1 parent 6b191ee commit 6041efe

File tree

1 file changed

+27
-7
lines changed

1 file changed

+27
-7
lines changed

docs/intro/ff-ui/my-organization.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ Webhooks are **only available** to users on the **Enterprise** plan.
306306

307307
:::
308308

309-
:::tip [Possible Use Cases]
309+
:::tip Possible Use Cases
310310

311311
- **CI/CD Integration:** Automatically trigger build or deployment pipelines whenever a new commit is made to a branch.
312312
- **Audit Logging:** Log events to an internal system for compliance and audit tracking.
@@ -320,20 +320,40 @@ Webhooks are **only available** to users on the **Enterprise** plan.
320320

321321
FlutterFlow supports webhook notifications for the following events:
322322

323-
- **Branch Created**: Triggered whenever a new branch is created within the project.
324-
- **Commit Created**: Triggered when a commit is created on any branch.
325-
- **User Info:**
323+
- **Branch Created**: Triggered whenever a new branch is created within the project. The following is an example of the webhook payload sent when this event occurs:
324+
```jsx
325+
{
326+
"branch_id": "mmtQj1gtGuxohyNsAUSs",
327+
"branch_name": "Hello World",
328+
"created_by": {
329+
"user_id": "TeneO93LdQfQQdN4RDfSB0eIXPu2"
330+
},
331+
"eventType": "branch.created",
332+
"project_id": "test-delete-me-wvv2hr"
333+
}
334+
```
335+
- **Commit Created**: Triggered when a commit is created on any branch. Below is an example of the webhook payload sent for this event:
336+
```jsx
337+
{
338+
"commit_id": "a1b2c3d4e5",
339+
"commit_message": "Initial commit for login feature",
340+
"branch_id": "mmtQj1gtGuxohyNsAUSs",
341+
"branch_name": "feature/login",
342+
"created_by": {
343+
"user_id": "TeneO93LdQfQQdN4RDfSB0eIXPu2"
344+
},
345+
"eventType": "commit.created",
346+
"project_id": "test-delete-me-wvv2hr"
347+
}
348+
```
326349

327-
[docusourous]
328350

329351
### Set Up Webhook
330352

331353
To start receiving webhook events, go to your **FlutterFlow Dashboard**, then navigate to **My Teams > Webhook URLs**. Click **+ Add URL**, enter your webhook endpoint, and click **Save**.
332354

333355
Once saved, FlutterFlow will automatically send POST requests to the provided URL whenever supported events occur.
334356

335-
[image]
336-
337357
:::tip[Allowlist IP Addresses]
338358

339359
If your webhook endpoint is hosted behind a firewall or NAT, you’ll need to allow incoming traffic from the following static IP addresses to ensure event delivery.

0 commit comments

Comments
 (0)