Skip to content

Rule.io SDK


Rule.io SDK / client/src / WebhookEvent

Type Alias: WebhookEvent

WebhookEvent = TransactionSentEvent | TransactionLinkClickedEvent | TransactionOpenedEvent | CampaignSentEvent | CampaignLinkClickedEvent | CampaignOpenedEvent | SubscriberOptedInEvent | SubscriberSuppressedEvent | SubscriberTagChangedEvent | SubscriberAddedToTagEvent | SubscriberRemovedFromTagEvent | SubscriberAddedToSegmentEvent | SubscriberBouncedEvent | SubscriberResubscribedEvent | ImportFinishedEvent

Defined in: client/src/webhooks/types.ts:221

Discriminated union of every webhook event the SDK currently parses.

Use switch (event.type) to narrow downstream. The 'subscriber.tag-changed' variant is the parser's default for tag webhooks; commit the direction with markTagDirection to narrow to 'subscriber.added-to-tag' or 'subscriber.removed-from-tag'.