connector.mdx

title	Connector
description	Connector protocol schemas

{/* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */}

**Source:** `packages/spec/src/api/connector.zod.ts`

TypeScript Usage

import { WebhookConfig, WebhookEvent } from '@objectstack/spec/api';
import type { WebhookConfig, WebhookEvent } from '@objectstack/spec/api';

// Validate data
const result = WebhookConfig.parse(data);

---

WebhookConfig

Properties

Property	Type	Required	Description
enabled	boolean	✅	Enable webhook support
events	{ name: string; description: string; method: Enum<'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS'>; payloadSchema: string; … }[]	✅	Registered webhook events
deliveryConfig	{ maxRetries: integer; retryIntervalMs: integer; timeoutMs: integer; signatureHeader: string }	✅	Webhook delivery configuration
registrationEndpoint	string	✅	URL path for webhook registration

---

WebhookEvent

Properties

Property	Type	Required	Description
name	string	✅	Webhook event identifier (snake_case)
description	string	✅	Human-readable event description
method	Enum<'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS'>	✅	HTTP method for webhook delivery
payloadSchema	string	✅	JSON Schema $ref for the webhook payload
headers	Record<string, string>	optional	Custom headers to include in webhook delivery
security	Enum<'hmac_sha256' | 'basic' | 'bearer' | 'api_key'>[]	✅	Supported authentication methods for webhook verification

---