Webhooks

Create webhook subscription

Subscribes a URL to one or more event types. The signing secret comes back once, so store it now. We check the target URL first and refuse private and loopback addresses.

API key scopes: webhooks:write.

post/api/webhook-subscriptions

Request

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

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 required
eventTypesstring[] required
workspaceScopedboolean
consumerMetadataobject
expiresAtstring date-time

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

signingSecretstring
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.