Skip to main content

WebhookPayloadSchema

const WebhookPayloadSchema: ZodDiscriminatedUnion<WebhookPayload>;

Wrapper schema for an incoming webhook payload.

The backend sends snake_case keys and uses the public event form (item:added) in the event_name field, so consumers using parseWebhookPayload receive camelCase fields directly.

Every WebhookEvent is typed today: item:* events carry a parsed Task; note:* events carry a parsed comment (item-comment or project-comment); label:* events carry a parsed label; project:* events carry a parsed Project (personal or workspace); section:* events carry a parsed WebhookSection; filter:* events carry a parsed Filter; reminder:fired carries a parsed WebhookFiredReminder.