Webhooks

Update webhook subscription

Changes the target URL, the event types, or the active flag. We re-check the URL on every change.

API key scopes: webhooks:write. You also need an Idempotency-Key header.

patch/api/webhook-subscriptions/{id}

Request

  • Base URL: https://api.setluca.com
  • URL: https://api.setluca.com/api/webhook-subscriptions/{id}
  • Auth: one of:
    • API key in cookie luca.session_token
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring uuid required

Identifier of the webhook subscription this operation targets.

Headers

Luca-API-Version'1'

The major version of the API this client was built against. Omit it and the request is served by the current major version. Any other value is refused with 400 unsupported_api_version.

Request body

targetUrlstring uri
eventTypesstring[]
status'active' | 'paused' | 'disabled'
consumerMetadataobject

Response

ok

idstring uuid required
organizationIdstring required
coachIdstring uuid nullable required
targetUrlstring required
eventTypesstring[] required
status'active' | 'paused' | 'disabled' | 'deleted' required
consumerMetadataobject required

Opaque JSON object

expiresAtstring nullable required
health'healthy' | 'degraded' | 'down'
createdAtstring required
updatedAtstring required

Changes

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