idstring required
Unique identifier for the webhook
orgIdstring required
Organization that owns this webhook
urlstring uri required
HTTPS endpoint URL receiving webhook payloads
eventsstring[] required
Event types this webhook is subscribed to
activeboolean required
Whether the webhook is currently active
descriptionstring nullable required
Human-readable label for this webhook
consecutiveFailuresinteger required
Number of consecutive delivery failures across all events
disabledReasonstring nullable required
Reason the webhook was auto-disabled, null if manually disabled or active
disabledAtstring date-time nullable required
ISO 8601 timestamp when the webhook was auto-disabled
createdAtstring date-time required
ISO 8601 timestamp when the webhook was created
updatedAtstring date-time required
ISO 8601 timestamp when the webhook was last modified
authType'NONE' | 'BEARER' | 'BASIC' | 'CUSTOM_HEADER' required
Auth scheme the platform presents to your endpoint (never includes the secret)
authHeaderNamestring nullable required
Header name for CUSTOM_HEADER auth; null for other schemes
rateLimitPerMinuteinteger nullable required
Per-endpoint delivery rate cap in requests/minute; null = unlimited
maxAttemptsinteger nullable required
Per-webhook max delivery attempts; null = platform default (3)