WebhookEndpointWithSecret
- authenticationrequired
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.- typeenumconst:nonerequired
- createdType: string
_at required - descriptionType: string | nullrequired
- disabledType: string | null
_at required - disabledType: string | nullenum
_reason requiredWhy the endpoint is disabled:
manual(you disabled it),failing(every attempt failed for 5 days),gone(the receiver answered 410).valuesmanualfailinggonenull - eventType: array of "audit.completed"enum
_types const:audit.completedrequired - failingType: string | null
_since requiredStart of the current run of failed attempts. After 5 days the endpoint is disabled with
disabled_reason: failing. - Properties: 2filtersType:required
- idType: stringFormat: uuidrequired
- objectenumconst:webhook_endpointrequired
- orgType: string
_id required - Properties: 5payloadType:required
- secretType: stringrequired
The signing secret (
whsec_+ base64). Returned only by create and rotate_secret: store it now, it is not returned again. - Properties: 3signingType:required
- statusType: "enabled" or "disabled"enumrequired
disabledendpoints receive no new deliveries. - updatedType: string
_at required - urlType: stringrequired