webhook.config.list
List all active webhook endpoint configurations for an account.
POST http://api.kompliant.com/webhook.config.list (OpenAPI specification)
Usage Info
This method returns all active (non-deleted) webhook URL configurations for an account. Deleted configurations are excluded from the results. If no configurations exist, an empty array is returned.
Request
Authentication: KSig1-HMAC-SHA256
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| account_id | string | Yes | The account identifier to list webhook configurations for. |
Example
{
"account_id": "account_id"
}
Response
Data
| Parameter | Type | Description |
|---|---|---|
| configs | array of objects | The configparameters are defined in the tables below. |
Config Parameters
| Parameter | Type | Description |
|---|---|---|
| config_id | string | The identifier for the webhook configuration (format: whc_...). |
| url | string | The HTTPS endpoint URL webhooks are delivered to. |
| created_at | string | The date-time when the configuration was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ). |
| updated_at | string | The date-time when the configuration was last updated in ISO 8601 format. |
Example
{
"meta": {
"status": "SUCCESS",
"trace_id": "trc_3OwNmn7AgCvLGqeCIjKjSD",
"version": "2025-03-24"
},
"data": {
"configs": [
{
"config_id": "whc_2K9mPxR7N4jL8hS6TdWfY3",
"url": "https://example.com/webhooks/kompliant",
"created_at": "2025-10-21T15:42:33.109Z",
"updated_at": "2025-10-21T15:42:33.109Z"
},
{
"config_id": "whc_5R2nQyT8M6kJ3gP1VcXeZ9",
"url": "https://backup.example.com/webhooks",
"created_at": "2025-11-01T10:00:00.000Z",
"updated_at": "2025-11-01T10:00:00.000Z"
}
]
}
}
Errors
| Error Code | HTTP Code | Possible Cause |
|---|---|---|
| BAD_REQUEST | 400 | Required parameters not provided. |
Updated 28 days ago