KIkit
Webhooks

Update a webhook endpoint

Changed on

Updates any of name, url, description, status, and events. Set status to disabled to stop deliveries without deleting the endpoint, and back to active to resume.

Note: events replaces the endpoint's entire subscription list — send the complete set you want, not just the additions.

Endpoints created by an app (via OAuth) can only be updated by that app; an API key request returns 403.

patch/v4/webhook_endpoints/{id}

Request

  • Base URL
    https://api.kit.com
  • URL
    https://api.kit.com/v4/webhook_endpoints/{id}
  • Auth
    • API key in header X-Kit-Api-Key
    • or OAuth 2
      Authorization code: https://api.kit.com/v4/oauth/authorize
      Token URL: https://api.kit.com/v4/oauth/token

Path parameters

idinteger required

Request body

namestring
urlstring
descriptionstring
status'active' | 'disabled'

Endpoint status. One of: active, disabled.

eventsstring[]

Event types this endpoint subscribes to (e.g. subscriber.created). On update, the list supplied here replaces the endpoint's full subscription list.

Response

Updates the webhook endpoint

Changes