webhook.config.get

Retrieve a webhook endpoint configuration.

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

Usage Info

This method retrieves the details of a specific webhook URL configuration by its config_id. Deleted configurations are not returned — 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 retrieve.

Example

{
  "account_id": "account_id",
  "config_id": "whc_2K9mPxR7N4jL8hS6TdWfY3"
}

Response

Data

ParameterTypeDescription
config_idstringThe identifier for the webhook configuration (format: whc_...).
urlstringThe HTTPS endpoint URL webhooks are delivered to.
created_atstringThe date-time when the configuration was created in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ).
updated_atstringThe date-time when the configuration was last updated in ISO 8601 format. Omitted if never updated.

Example

{
  "meta": {
    "status": "SUCCESS",
    "trace_id": "trc_3OwNmn7AgCvLGqeCIjKjSD",
    "version": "2025-03-24"
  },
  "data": {
    "config_id": "whc_2K9mPxR7N4jL8hS6TdWfY3",
    "url": "https://example.com/webhooks/kompliant",
    "created_at": "2025-10-21T15:42:33.109Z",
    "updated_at": "2025-11-05T09:14:22.500Z"
  }
}

Errors

Error CodeHTTP CodePossible Cause
BAD_REQUEST400Required parameters not provided. config_id format is invalid.
ENTITY_NOT_FOUND404The config_id does not exist or has been deleted for this account.