CHcheckhq

List webhook configs

Changed on

Returns a list of webhook configs.

get/webhook_configs

Request

Query parameters

limitinteger

Number of webhook configs returned per page. The maximum value is 500.

idstring[]

Filter the list to the specified IDs. For more details, check out the Bulk Get Requests guide.

Response

200

idstring
urlstring
keystring
activeboolean
api_version'2021-01-15' | '2021-02-16' | '2021-04-08' | '2021-09-02' | '2023-04-04' | '2025-01-01' nullable

API version used to serialize webhook event payloads for this config. When null, payloads follow your account's default API version.

Example response

[
  {
    "id": "whc_7uCODm8JFmZyov9jL8QO",
    "url": "http://3385edbc219e.ngrok.io",
    "key": "2bfce877d2e64ea6a8dd45ffb2ce897eb4d97485",
    "active": true
  }
]

Changes

  • 5a54f5eb888bRevision changes
    • info

      added the new optional query request parameter id

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status