Webhooks

Create site webhook

Creates a webhook and returns its signing secret exactly once. Human dashboard session only.

post/api/sites/{id}/webhooks

Request

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

Path parameters

idstring 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

Created webhook and one-time secret

secretstring required

One-time signing secret. It is returned only on creation or rotation.

Changes

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