Skip to content

FYInbox docs

Notification payload

Start with a title, then add severity, body, tags, metadata, event identity, timestamp, and safe link actions only when useful.

Fields

FieldRequiredMeaning
titleYesShort human-readable event summary.
bodyNoPlain-text detail; it is never rendered as HTML.
severityNoinfo, success, warning, error, or critical; defaults to info.
tagsNoNormalized labels; defaults to an empty list.
sourceNoDescriptive producer label; it does not select key scope.
externalIdNoIdentifier from the producing system.
deduplicationKeyNoStable event identity used for safe create retries.
metadataNoBounded string key/value context for filtering.
actionsNoUp to five HTTPS or mailto link actions.
createdAtNoProducer event time as an ISO 8601 date-time with offset.

Validation and normalization

  • The request is a strict JSON object; unknown fields are rejected.
  • Title, tags, identifiers, and metadata keys are trimmed within their documented bounds.
  • Tags are lowercased, converted to slugs, and deduplicated by normalized slug.
  • Metadata keys are normalized to lowercase and collisions after normalization are rejected.
  • Action IDs must be unique and at most one action may use the primary style.