Type Alias: CreateWebhookSubscriptionRequest
Properties
| Property | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Webhook URL (example: "https://example.com/webhook") |
secret | string | Yes | Secret for HMAC-SHA256 signature verification (example: "my_secret_key") |
events | string[] | Yes | List of events to subscribe to. Supports wildcards like "message." or "" (example: ["session.created","message.*"]) |
description | string | No | Description of this webhook (example: "Production webhook endpoint") |
authType | "none" | "api_key" | "basic_auth" | "custom_headers" | No | How Cortex authenticates when POSTing to your webhook URL. Defaults to 'none' if omitted. |
apiKey | string | No | API key value (for api_key auth) (example: "sk_live_xxx") |
apiKeyHeader | string | No | Header name to send the API key in (for api_key auth). Defaults to 'X-API-Key' if omitted. (example: "X-API-Key") |
basicAuthUsername | string | No | Basic auth username |
basicAuthPassword | string | No | Basic auth password |
customHeaders | object | No | Custom headers to send with webhook requests (example: {"X-Custom-Header":"value"}) |
Defined in
4Players/cortex-typescript-sdk/src/resources/webhooks.ts:15