POST /v1/sign_in_hooks
Adds the environments hook for a point (Business and Enterprise; plan_limit_reached below). pre_profile_issue is called synchronously before every profile is issued and may deny the sign-in or add bounded claims; post_directory_event receives directory events asynchronously. The signing secret is returned once, in this response. A second hook for the same point is conflict.
- Scope
policies:write- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Request body
Section titled “Request body”pointstring Requiredone of
pre_profile_issue,post_directory_eventurlstring Requiredmin length 9 · max length 2048
fail_modestringclosed(default) refuses the sign-in when the hook does not answer validly;opencontinues without claims.one of
closed,opentimeout_msintegermin 100 · max 5000 · default
2000enabledbooleandefault
true
Responses
Section titled “Responses”- 201 OK SignInHookWithSecret
- 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
- 409 Codes: idempotency_key_reused and resource-specific conflicts. 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" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "point": "pre_profile_issue", "url": "https://app.acme.com/callback"}'const response = await fetch("https://api.ohauthcat.com/v1/sign_in_hooks", { method: "POST", headers: { Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "point": "pre_profile_issue", "url": "https://app.acme.com/callback" }),});const data = await response.json();import osimport requests
response = requests.post( "https://api.ohauthcat.com/v1/sign_in_hooks", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"}, json={ "point": "pre_profile_issue", "url": "https://app.acme.com/callback", },)data = response.json(){ "id": "hook_01J9ZQ4M7K2X8V3N5B6C1D0E9F", "object": "sign_in_hook", "point": "pre_profile_issue", "url": "https://app.acme.com/callback", "fail_mode": "closed", "timeout_ms": 100, "enabled": true, "created_at": "2026-01-15T09:30:00Z", "updated_at": "2026-01-15T09:30:00Z", "secret": "sk_test_example"}