Skip to content
Dashboard
Theme
Theme

Send a test event to a sign-in hook

POST /v1/sign_in_hooks/{hook}/test: Send a test event to a sign-in hook.

View Markdown

POST /v1/sign_in_hooks/{hook}/test

Calls the hook now with a synthetic, clearly marked test payload (test@example.com, no real user) signed with its secret, and reports what happened: outcome, the HTTP status it answered, latency and a catalog failure cause. The answer’s claims and reason are not returned. Nothing is recorded in the delivery log; the call is audited as sign_in_hook.tested. Disabled hooks are tested too.

Scope
policies:write
Auth
Secret key (sk_…)
Since
1.0
  • hook string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/sign_in_hooks/hook_01J9ZQ4M7K2X8V3N5B6C1D0E9F/test" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY"
Response 200
{
"object": "sign_in_hook_test",
"hook_id": "hook_01J9ZQ4M7K2X8V3N5B6C1D0E9F",
"outcome": "example_outcome",
"status_code": 1,
"duration_ms": 1,
"error": "example_error"
}