Webhooks
An outbound HTTP call that the system sends to an external address when a business event occurs.
- API name:
webhooks - Domain: Features
- Modules: Administration
Fields
The API name is what the API, MCP and the CLI use.
| Name | API name | Type | Required | Description |
|---|---|---|---|---|
| ID | id | Record ID | Yes | |
| Name | label | Text | Yes | |
| Table | tableUid | Constant | Business table this row points to. | |
| Event | event | Constant | Fixed option from the allowed set for this field. | |
| Record | recordId | Reference | ||
| Condition | condition | Button | ||
| Method | method | Constant | Yes | Fixed option from the allowed set for this field. |
| URL | url | Text | Yes | |
| Signing secret | signingSecret | Text | Standard Webhooks secret (whsec_ followed by base64). The form creates one. The receiver uses it to check the webhook-signature header. | |
| Headers | headers | Button | Yes | |
| Body | body | Button | ||
| Tags | tagIds | Tags | ||
| Description | description | Text Area | ||
| Created by | createdBy | User | ||
| Created at | createdAt | Date and Time | Yes | |
| Updated by | updatedBy | User | ||
| Updated at | updatedAt | Date and Time | Yes | |
| Blocked by | blockedBy | User | ||
| Blocked at | blockedAt | Date and Time | ||
| Archived by | archivedBy | User | ||
| Archived at | archivedAt | Date and Time |
Relations
| Field | Points to | Kind |
|---|---|---|
Tags tagIds | Tags | reference |
Actions
What you can do with a record. Every action also sends the webhook event webhooks.<action>. Reads (find, get, count) work on every table.
| Name | API name | Description | Where |
|---|---|---|---|
| Create | create | Add a new webhook. | App · WebMCP · API · MCP · CLI |
| Edit | update | Save changes to this webhook. | App · WebMCP · API · MCP · CLI |
| Block | block | Stop edits and deletion of this webhook. It stays visible and can still appear on existing documents. Unblock to edit again. | App · WebMCP · API · MCP · CLI |
| Unblock | unblock | Allow edits and deletion of this webhook again. | App · WebMCP · API · MCP · CLI |
| Archive | archive | Retire this webhook from daily use. It leaves active lists and pickers, and most actions stop. Unarchive to restore it. | App · WebMCP · API · MCP · CLI |
| Restore | unarchive | Return this webhook to active lists and actions. | App · WebMCP · API · MCP · CLI |