Skip to main content
POST
/
v1
/
webhooks
Create Webhook Subscription
curl --request POST \
  --url https://api.example.com/v1/webhooks \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "url": "<string>",
  "event_types": [
    "patient_created"
  ],
  "description": "<string>"
}
'
{
  "created_at": "2024-01-15T10:30:00Z",
  "description": "Production webhook endpoint",
  "event_types": [
    "patient_created",
    "patient_stage_changed"
  ],
  "id": "550e8400-e29b-41d4-a716-446655440016",
  "is_active": true,
  "updated_at": "2024-01-15T10:30:00Z",
  "url": "https://example.com/webhooks/solum"
}

Authorizations

X-API-Key
string
header
required

Body

application/json

Request model for creating a webhook subscription

url
string<uri>
required

The webhook endpoint URL

Required string length: 1 - 2083
event_types
enum<string>[]
required

List of event types to subscribe to

Available options:
patient_created,
patient_stage_changed,
patient_updated,
patient_insurance_verification,
patient_verification_completed
description
string | null

Optional description for the webhook

Response

Successful Response

Webhook subscription resource.

Represents a webhook endpoint configuration for receiving events.

id
string<uuid>
required
url
string
required
event_types
string[]
required
is_active
boolean
required
company_id
string
required
created_at
string | null
required
updated_at
string | null
required
description
string | null
secret_key
string | null