Retrieve the payload schema of a log event type
Changed onReturns the payload schema of a log event type: which fields its payload carries, addressed by the dot-paths that the payload_filter and payload_fields parameters of the list endpoint accept.
type accepts a concrete event type (sign_in.completed), a trailing-* wildcard (sign_in.*), or a bare family name (sign_in, normalized to sign_in.* when no concrete type matches — the response's event_type echoes the normalized form). For wildcard lookups the fields are the intersection across every matching event type, and matched_event_types lists what the intersection was computed over; per-type metadata (description, severity, docs_group) is present only for concrete types.
The response is the same for every instance.
Request
- Base URLhttps://api.clerk.com/v1
- URLhttps://api.clerk.com/v1/logs/schemas
- AuthHTTP bearer
Query parameters
The event type to describe: concrete (sign_in.completed), trailing-* wildcard (sign_in.*), or bare family name (sign_in). Unknown types return a 422. A bare * is not accepted.
Response
The payload schema of a log event type.
Example response
{
"object": "log_schema",
"event_type": "sign_in.completed",
"description": "Sign in was completed",
"severity": "success",
"docs_group": "Sign-in events",
"fields": [
{
"path": "user_id"
}
]
}Changes
- info
endpoint added
- info
- breaking
api path removed without deprecation
- breaking