Skip to main content

Type Alias: UpdateWebhookSubscriptionRequest

type UpdateWebhookSubscriptionRequest: components["schemas"]["UpdateWebhookSubscriptionRequest"];

Properties

PropertyTypeRequiredDescription
urlstringNoWebhook URL (example: "https://example.com/webhook")
secretstringNoSecret for HMAC-SHA256 signature verification
eventsstring[]NoList of events to subscribe to
descriptionstringNoDescription of this webhook
isActivebooleanNoWhether the subscription is active
authType"none" | "api_key" | "basic_auth" | "custom_headers"NoAuthentication type
apiKeystringNoAPI key value
apiKeyHeaderstringNoAPI key header name
basicAuthUsernamestringNoBasic auth username
basicAuthPasswordstringNoBasic auth password
customHeadersobjectNoCustom headers

Defined in

4Players/cortex-typescript-sdk/src/resources/webhooks.ts:20