WebhookEndpoint

authentication
required

How Brellium authenticates to your receiver, on top of the always-on signature. Secret values (header_value, password, client_secret) are write-only and never returned.
How Brellium authenticates to your receiver, on top of the always-on signature. Secret values (header_value, password, client_secret) are write-only and never returned.
type
enum
const:
none
required
created_at
Type: string
required
description
Type: string | null
required
disabled_at
Type: string | null
required
disabled_reason
Type: string | nullenum
required

Why the endpoint is disabled: manual (you disabled it), failing (every attempt failed for 5 days), gone (the receiver answered 410).

values
manualfailinggonenull
event_types
Type: array of "audit.completed"enum
const:
audit.completed
required
failing_since
Type: string | null
required

Start of the current run of failed attempts. After 5 days the endpoint is disabled with disabled_reason: failing.
filters
Type:
required
Properties: 2
id
Type: stringFormat: uuid
required
object
enum
const:
webhook_endpoint
required
org_id
Type: string
required
payload
Type:
required
Properties: 5
signing
Type:
required
Properties: 3
status
Type: "enabled" or "disabled"enum
required

disabled endpoints receive no new deliveries.
updated_at
Type: string
required
url
Type: string
required