webhook.config.update

Update a webhook endpoint configuration.

POST http://api.kompliant.com/webhook.config.update (OpenAPI specification)

Usage Info

This method updates the URL of an existing webhook configuration. The new URL must be a valid HTTPS endpoint and must not already be registered to another configuration on the same account.

Deleted configurations cannot be updated — they will result in an ENTITY_NOT_FOUND error.

Request

Authentication: KSig1-HMAC-SHA256

Parameters

ParameterTypeRequiredDescription
account_idstringYesThe account identifier the webhook configuration belongs to.
config_idstringYesThe identifier of the webhook configuration to update.
configobjectYesThe config parameter defined in the table below.

Config Parameters

TypeParameterRequiredDescription
urlstringYesThe new HTTPS endpoint URL to deliver webhook payloads to. Must start with https://.

Example

{
  "account_id": "account_id",
  "config_id": "whc_2K9mPxR7N4jL8hS6TdWfY3",
  "config": {
    "url": "https://example.com/webhooks/kompliant-v2"
  }
}

Response

A successful update returns an empty data object.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_3OwNmn7AgCvLGqeCIjKjSD",
    "version": "2025-03-24"
  },
  "data": {}
}

Errors

Error CodeHTTP CodePossible Cause
BAD_REQUEST400Required parameters not provided. config_id format is invalid. URL does not start with https://.
ENTITY_NOT_FOUND404The config_id does not exist or has been deleted for this account.
SYSTEM_RULE_VIOLATION400System rule violations are described below.

System Rule Violations

When a SYSTEM_RULE_VIOLATION error occurs, the response will include additional entity_type and sub_code fields to provide more specific information:

Entity TypeSub-codeDescription
Webhook ConfigURL_ALREADY_EXISTSA webhook configuration with this URL already exists for this account.