Webhooks

Configure webhook subscriptions

List webhooks

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key in format kros_live_xxxx for production or kros_test_xxxx for testing. Also accepts JWT tokens from Supabase Auth for dashboard sessions.

Header parameters

x-organization-idstring · uuidOptional

Organization UUID for multi-tenant context. Falls back to user's first organization if not provided.

Responses

200

List of webhooks

application/json

401

Unauthorized - Invalid or missing API key

application/json

get

/webhooks

HTTPcURLJavaScriptPython

GET /v1/webhooks HTTP/1.1
Host: api.krosai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "aa0e8400-e29b-41d4-a716-446655440005",
    "url": "https://api.example.com/webhooks/krosai",
    "events": [
      "call.started",
      "call.completed",
      "call.failed"
    ],
    "active": true,
    "created_at": "2024-01-15T10:30:00Z"
  }
]

Create webhook

post

Creates a new webhook subscription. A signing secret is auto-generated for payload verification.

Authorizations

BearerAuth

AuthorizationstringRequired

API key in format kros_live_xxxx for production or kros_test_xxxx for testing. Also accepts JWT tokens from Supabase Auth for dashboard sessions.

Header parameters

x-organization-idstring · uuidOptional

Organization UUID for multi-tenant context. Falls back to user's first organization if not provided.

Body

application/json

urlstring · uriRequired

activebooleanOptionalDefault: true

Responses

201

Webhook created

application/json

400

Bad request - Invalid parameters or request body

application/json

401

Unauthorized - Invalid or missing API key

application/json

post

/webhooks

HTTPcURLJavaScriptPython

POST /v1/webhooks HTTP/1.1
Host: api.krosai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "url": "https://api.example.com/webhooks/krosai",
  "events": [
    "call.started",
    "call.completed",
    "call.failed",
    "call.recording.ready"
  ],
  "active": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com",
  "secret": "text",
  "events": [
    "call.started"
  ],
  "active": true,
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-03T13:43:55.024Z",
  "updated_at": "2026-02-03T13:43:55.024Z"
}

Get webhook details

get

Authorizations

BearerAuth

AuthorizationstringRequired

API key in format kros_live_xxxx for production or kros_test_xxxx for testing. Also accepts JWT tokens from Supabase Auth for dashboard sessions.

Path parameters

idstring · uuidRequired

Webhook UUID

Header parameters

x-organization-idstring · uuidOptional

Organization UUID for multi-tenant context. Falls back to user's first organization if not provided.

Responses

200

Webhook details

application/json

404

Resource not found

application/json

get

/webhooks/{id}

HTTPcURLJavaScriptPython

GET /v1/webhooks/{id} HTTP/1.1
Host: api.krosai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com",
  "secret": "text",
  "events": [
    "call.started"
  ],
  "active": true,
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-03T13:43:55.024Z",
  "updated_at": "2026-02-03T13:43:55.024Z"
}

Delete webhook

delete

Authorizations

BearerAuth

AuthorizationstringRequired

API key in format kros_live_xxxx for production or kros_test_xxxx for testing. Also accepts JWT tokens from Supabase Auth for dashboard sessions.

Path parameters

idstring · uuidRequired

Webhook UUID

Header parameters

x-organization-idstring · uuidOptional

Organization UUID for multi-tenant context. Falls back to user's first organization if not provided.

Responses

204

Webhook deleted

404

Resource not found

application/json

delete

/webhooks/{id}

HTTPcURLJavaScriptPython

DELETE /v1/webhooks/{id} HTTP/1.1
Host: api.krosai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update webhook

patch

Authorizations

BearerAuth

AuthorizationstringRequired

API key in format kros_live_xxxx for production or kros_test_xxxx for testing. Also accepts JWT tokens from Supabase Auth for dashboard sessions.

Path parameters

idstring · uuidRequired

Webhook UUID

Header parameters

x-organization-idstring · uuidOptional

Organization UUID for multi-tenant context. Falls back to user's first organization if not provided.

Body

application/json

urlstring · uriOptional

activebooleanOptional

Responses

200

Webhook updated

application/json

400

Bad request - Invalid parameters or request body

application/json

404

Resource not found

application/json

patch

/webhooks/{id}

HTTPcURLJavaScriptPython

PATCH /v1/webhooks/{id} HTTP/1.1
Host: api.krosai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 58

{
  "events": [
    "call.started",
    "call.completed"
  ],
  "active": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "url": "https://example.com",
  "secret": "text",
  "events": [
    "call.started"
  ],
  "active": true,
  "organization_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-02-03T13:43:55.024Z",
  "updated_at": "2026-02-03T13:43:55.024Z"
}

Test webhook

post

Sends a test payload to the webhook endpoint

Authorizations

BearerAuth

AuthorizationstringRequired

API key in format kros_live_xxxx for production or kros_test_xxxx for testing. Also accepts JWT tokens from Supabase Auth for dashboard sessions.

Path parameters

idstring · uuidRequired

Webhook UUID

Header parameters

x-organization-idstring · uuidOptional

Organization UUID for multi-tenant context. Falls back to user's first organization if not provided.

Responses

200

Test result

application/json

post

/webhooks/{id}/test

HTTPcURLJavaScriptPython

POST /v1/webhooks/{id}/test HTTP/1.1
Host: api.krosai.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Test result

{
  "success": true,
  "status_code": 200,
  "message": "Webhook test delivered successfully"
}