Skip to main content

Failed Notification

client_name
string
required

Client name associated with the client_id, when available. May be empty string.

description
string
required

Description of the event. This can also contain a description of the issue for failure logs.

details
object
required

Log details

environment_name
string
required

The name of the environment where the event occurred

Examples:

"prod-eu-1"

"prod-us-1"

ip
required

The IP address associated with the request. For an auth related log this should be the end user IP. For a machine-to-machine auth flow this should be the IP of the computer doing the authentication. For management logs like sapi and mgmt_api_read this should be the IP of the admin using the manage dashboard.

log_id
string
required

Log id

tenant_name
string
required

Tenant name

type
string
required

Failed Notification

Allowed value: "fn"
$event_schema
object

Event schema meta

client_id
string | null

Client related to the API call. Clients are also called applications. The underlying application may not be owned by your tenant and may not be accessible. For failure logs, this may be a valid ID, an invalid one, or any ID.

connection
string

Name of the connection, when available. The connection here matches the connection_id field.

connection_id
string

ID of the connection on which the auth flow is happening or connection of the user doing the action, when applicable. For failure logs this field may contain an invalid ID.

date
string

The date when the event occurred in ISO 8601 format

Example:

"2024-01-15T10:30:00.000Z"

is_mobile
boolean

Whether the request originated from a mobile device. Only present when user_agent is available.

references
object

References for correlating related events across services and stitching them into distributed traces.

user_agent
string

The user_agent behind this log, when available

Example:

"Chrome 120.0.0 / Mac OS X 10.15.7"