ObjectStackObjectStack

Webhook

Webhook protocol schemas

Webhook Trigger Event

When should this webhook fire?

Source: packages/spec/src/automation/webhook.zod.ts

TypeScript Usage

import { Webhook, WebhookReceiver, WebhookTriggerType } from '@objectstack/spec/automation';
import type { Webhook, WebhookReceiver, WebhookTriggerType } from '@objectstack/spec/automation';

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

Webhook

Properties

PropertyTypeRequiredDescription
namestring✅Webhook unique name (lowercase snake_case)
labelstringoptionalHuman-readable webhook label
objectstringoptionalObject to listen to (optional for manual webhooks)
triggersEnum<'create' | 'update' | 'delete' | 'undelete' | 'api'>[]optionalEvents that trigger execution
urlstring✅External webhook endpoint URL
methodEnum<'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'>✅HTTP method
headersRecord<string, string>optionalCustom HTTP headers
bodyanyoptionalRequest body payload (if not using default record data)
payloadFieldsstring[]optionalFields to include. Empty = All
includeSessionboolean✅Include user session info
authenticationObjectoptionalAuthentication configuration
retryPolicyObjectoptionalRetry policy configuration
timeoutMsinteger✅Request timeout in milliseconds
secretstringoptionalSigning secret for HMAC signature verification
isActiveboolean✅Whether webhook is active
descriptionstringoptionalWebhook description
tagsstring[]optionalTags for organization

WebhookReceiver

Properties

PropertyTypeRequiredDescription
namestring✅Webhook receiver unique name (lowercase snake_case)
pathstring✅URL Path (e.g. /webhooks/stripe)
verificationTypeEnum<'none' | 'header_token' | 'hmac' | 'ip_whitelist'>✅
verificationParamsObjectoptional
actionEnum<'trigger_flow' | 'script' | 'upsert_record'>✅
targetstring✅Flow ID or Script name

WebhookTriggerType

Allowed Values

  • create
  • update
  • delete
  • undelete
  • api

On this page

TypeScript UsageWebhookPropertiesWebhookReceiverPropertiesWebhookTriggerTypeAllowed Values