Reference / Webhooks

Register a webhook endpoint. Returns the signing secret once.

POST /v1/webhooks

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
event_types string[]
url string required

Responses

201 Endpoint created

{
  "data": {
    "created_at": "2026-01-15T09:30:00Z",
    "description": "string",
    "event_types": [
      "string"
    ],
    "id": "018f3c4a-7b2e-7c1d-9e0a-1f2b3c4d5e6f",
    "status": "string",
    "url": "string",
    "secret": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}

422 Invalid url

Request

curl -X POST "http://localhost:8080/v1/webhooks" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "string",
  "event_types": [
    "string"
  ],
  "url": "https://example.com/webhooks/identra"
}'

Try it

live request

POST http://localhost:8080/v1/webhooks

Request body

application/json