Webhooks

Update a webhook. At least one of name, url, or active is required. Scope and event selection cannot be changed.

patch/webhooks/{hookId}

Request

  • Base URL: https://api.hackmd.io/v1
  • URL: https://api.hackmd.io/v1/webhooks/{hookId}
  • Auth: HTTP bearer

Path parameters

hookIdstring required

Request body

activeboolean
urlstring
namestring nullable

Response

Ok

updatedAtnumber double required
createdAtnumber double required
eventDeliveryMode'all_supported_events' required
deliveryPolicyReason'unsafe_destination' | 'suspicious_pattern' | 'policy_violation' | 'null' nullable required
deliveryPolicyStatus'normal' | 'suppressed' required
configuredStatusReason'scope_deleted' | 'null' nullable required
configuredStatus'active' | 'disabled' required
urlstring required
namestring required
idstring required

Changes

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