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.
POST /
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
Path parameters
Section titled “Path parameters”hookstring Required
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 OK SignInHookTestResult
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 404 Code: resource_not_found (also returned for other tenants’ IDs); a path no endpoint serves answers route_not_found. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
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"const response = await fetch("https://api.ohauthcat.com/v1/sign_in_hooks/hook_01J9ZQ4M7K2X8V3N5B6C1D0E9F/test", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, },});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/sign_in_hooks/hook_01J9ZQ4M7K2X8V3N5B6C1D0E9F/test", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "object": "sign_in_hook_test", "hook_id": "hook_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "outcome": "example_outcome", "status_code": 1, "duration_ms": 1, "error": "example_error"}