Webhooks

Update a webhook subscription

Partially updates a subscription. Omitted secrets retain their stored values.

A supplied url must include an endpoint path; the rule applies to the URL being saved, so a subscription stored with a bare URL keeps working until its URL is changed.

Required scope: webhooks:write

patch/webhooks/{webhook_id}

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/webhooks/{webhook_id}
  • Auth: API key in header API-Key

Path parameters

webhook_idstring uuid required

Request body

namestring
urlstring uri

Delivery endpoint. Must be an http or https URL that includes an endpoint path, for example https://api.example.com/webhooks/events. A bare origin with no path (or a path of just /) is rejected.

enabledboolean
source'keycloak' | 'platform'
event_typesstring[]
signing_secretstring password
cluster_idstring uuid
realm_idstring uuid

Keycloak realm ID. This is a UUID generated by Keycloak.

authorization_headerstring password

Example request

{
  "realm_id": "123e4567-e89b-12d3-a456-426614174000"
}

Response

The request has succeeded.

idstring uuid required
namestring required
urlstring required
enabledboolean required
source'keycloak' | 'platform' required
event_typesstring[] required
cluster_idstring uuid
realm_idstring
has_authorization_headerboolean required
has_signing_secretboolean required
created_atstring date-time required
updated_atstring date-time required

Changes

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