Reference / Hooks

Create a hook (returns the signing secret once).

POST /v1/hooks

Secret API key operationId: create

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Request body · required

description string
fail_open boolean

On error/timeout: allow (true, default) or deny (false).
point string required

`pre_sign_up` | `pre_token_issue`.
timeout_ms integer<int32> int32
url string required

Responses

201 Hook created

{
  "data": {
    "created_at": "2026-01-15T09:30:00Z",
    "description": "string",
    "enabled": false,
    "fail_open": false,
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "point": "pre_sign_up",
    "timeout_ms": 0,
    "url": "string",
    "secret": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}

422 Invalid point/url

Request

curl -X POST "http://localhost:8080/v1/hooks" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "fail_open": false,
  "point": "pre_token_issue",
  "timeout_ms": 0,
  "url": "https://api.example.com/identra/hooks"
}'

Try it

live request

POST http://localhost:8080/v1/hooks

Request body

application/json