v10

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-21162658.7 KB
partner-webhooks

Partner launch session event

Signed notification sent to the HTTPS webhook URL registered during onboarding. Verify the HMAC-SHA256 signature against the exact raw request body using the dedicated webhook secret. Return any 2xx response within 10 seconds after durable acceptance.

postWebhookpartnerLaunchSessionEvent

Headers

Everbility-Webhook-Idstring required
Example:pwevt_eYQdV8wYz4cZQ3JQ7r2x8w

Stable event ID. Use it to deduplicate retries.

Everbility-Webhook-Timestampstring required
Example:1784091792

Unix timestamp for this delivery attempt.

Everbility-Webhook-Signaturestring required

Versioned HMAC-SHA256 signature: v1=<64-character hexadecimal digest>.

Payload

idstring required

Stable event ID used for deduplication.

type'launch_session.opened' | 'launch_session.completed' | 'launch_session.expired' required
created_atstring date-time required

Example payload

{
  "id": "pwevt_eYQdV8wYz4cZQ3JQ7r2x8w",
  "type": "launch_session.completed",
  "created_at": "2026-07-15T05:03:12Z",
  "data": {
    "session_id": "psess_Zl9nB1qFhOQe2kQ4rW8xJ3Ty",
    "status": "completed",
    "external_client_id": "your-client-42",
    "clinician_email": "jordan@examplepractice.com",
    "opened_at": "2026-07-15T04:22:41Z",
    "completed_at": "2026-07-15T05:03:12Z",
    "expires_at": "2026-07-17T04:15:00Z",
    "document_url": "/v1/partner/launch-sessions/psess_Zl9nB1qFhOQe2kQ4rW8xJ3Ty/document"
  }
}

Response

Event accepted. Any 2xx status is treated as success.