Documentation Index
Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt
Use this file to discover all available pages before exploring further.
A webhook config sends HTTP notifications when RootFi events occur. Use webhook logs to inspect delivery status, payloads, and retry attempts.
Lifecycle
- Create — register a webhook URL (
POST /v4/core/webhook-config).
- Manage — list, get, update, or delete configs.
- Monitor — list delivery logs and inspect individual deliveries.
Response envelope
Successful JSON responses are wrapped as:
{
"data": { ... },
"request_id": "uuid"
}
DELETE /core/webhook-config/{webhookConfigId} returns 204 No Content with an empty body.
Webhook config object
List, get, create, and update responses return these fields (snake_case):
| Field | Type | Description |
|---|
rootfi_id | integer | Webhook config ID. |
webhook_type | enum | Event category (see below). |
integration_type | enum | null | Required for INTEGRATION webhooks. |
name | string | Display name. |
url | string | Destination URL. |
state | enum | ENABLED or DISABLED. |
topics | string[] | Subscribed topics. |
headers | object[] | null | Custom headers ({ name, value }). |
signature_header | string | null | Header name used for request signing. |
rootfi_organisation_id | integer | Organization ID. |
rootfi_created_at | string | Creation timestamp (ISO 8601). |
rootfi_updated_at | string | Last update timestamp (ISO 8601). |
Webhook types
| Value | Description |
|---|
INTEGRATION | Platform-native integration events. |
DATA_MODEL_CHANGES | Unified data model create/update/delete. |
CONNECTION_CHANGED | Connection lifecycle events. |
SYNC_STARTED | Sync started. |
SYNC_COMPLETED | Sync completed. |
Webhook log object
Delivery logs use camelCase:
| Field | Type | Description |
|---|
id | string | Delivery ID. |
webhookName | string | Webhook config name. |
webhookUrl | string | Destination URL. |
state | enum | PENDING, PROCESSING, DELIVERED, FAILED. |
latestStatusCode | integer | null | Latest HTTP status code. |
attemptCount | integer | Number of delivery attempts. |
eventType | string | null | Event type. |
integration | enum | null | Integration type, if applicable. |
syncId | string | null | Related sync ID, if applicable. |
createdAt | string | Creation timestamp (ISO 8601). |
updatedAt | string | Last update timestamp (ISO 8601). |
payload and attempts[].
