Webhooks

Update a webhook endpoint

patch/api/webhook-endpoints/{id}

Request

  • Base URL: http://localhost:38200
  • URL: http://localhost:38200/api/webhook-endpoints/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie token

Path parameters

idinteger required

Request body

urlstring
descriptionstring nullable
eventTypesLifecycleEventType[]

Response

Updated endpoint.

idinteger
tenantIdinteger
urlstring
descriptionstring nullable
eventTypesLifecycleEventType[]

Empty array means "subscribed to every lifecycle event type".

status'active' | 'paused' | 'revoked'
secretstring nullable

Populated only on create and rotate-secret responses.

lastDeliveryAtstring date-time nullable
lastDeliveryStatusstring nullable
lastDeliveryErrorstring nullable
createdByUserIdinteger nullable
createdAtstring date-time
updatedAtstring date-time

Changes

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