Webhooks

Update instance webhook

Updates configuration without changing the signing secret.

put/api/admin/webhooks/{webhookID}

Request

  • Base URL: https://demo.hitkeep.com
  • URL: https://demo.hitkeep.com/api/admin/webhooks/{webhookID}
  • Auth: API key in cookie hk_token

Path parameters

webhookIDstring uuid required

Request body

descriptionstring
enabledboolean required
eventsstring[] required
namestring required
urlstring uri required

HTTPS destination. Loopback, private, link-local, multicast, and otherwise unsafe addresses are rejected unless development targets are explicitly enabled.

Response

Updated webhook

created_atstring date-time required
descriptionstring required
enabledboolean required
eventsstring[] required
idstring uuid required
namestring required
scope'instance' | 'site' required
site_idstring uuid nullable
updated_atstring date-time required
urlstring uri required

Changes

No recorded changes to this operation across all 1 revision of this API.