Home > @uniformdev/webhooks

webhooks package

Functions

Function

Description

definition(options, example)

isDefinition(obj)

Variables

Variable

Description

ArchivedReleaseLaunchStartedDefinition

AssetDeletedDefinition

AssetDeletedEventName

AssetDeletePayloadSchema

AssetPayloadSchema

AssetPublishedDefinition

AssetPublishedEventName

CompositionChangedDefinition

CompositionChangedEventName

CompositionDeletedDefinition

CompositionDeletedEventName

CompositionDeletePayloadSchema

CompositionPayloadSchema

CompositionPublishedDefinition

CompositionPublishedEventName

CompositionReleaseChangedDefinition

CompositionReleaseChangedEventName

CompositionReleaseDeletedDefinition

CompositionReleaseDeletedEventName

CompositionReleasePublishedDefinition

CompositionReleasePublishedEventName

CompositionReleaseRestoredDefinition

CompositionReleaseRestoredEventName

CompositionRestorePayloadSchema

CompositionTriggerPayloadSchema

EntryChangedDefinition

EntryChangedEventName

EntryDeletedDefinition

EntryDeletedEventName

EntryDeletePayloadSchema

EntryPayloadSchema

EntryPublishedDefinition

EntryPublishedEventName

EntryReleaseChangedDefinition

EntryReleaseChangedEventName

EntryReleaseDeletedDefinition

EntryReleaseDeletedEventName

EntryReleasePublishedDefinition

EntryReleasePublishedEventName

EntryReleaseRestoredDefinition

EntryReleaseRestoredEventName

EntryRestorePayloadSchema

EntryTriggerPayloadSchema

ManifestPublishedDefinition

ManifestPublishedEventName

NotificationCreatedDefinition

NotificationCreatedEventName

NotificationEntitySchema

NotificationPayloadSchema

NotificationSummarySchema

ProjectMapDeleteDefinition

ProjectMapDeletedEventName

ProjectMapNodeDeleteDefinition

ProjectMapNodeDeletedEventName

ProjectMapNodeInsertDefinition

ProjectMapNodeInsertedEventName

ProjectMapNodeUpdateDefinition

ProjectMapNodeUpdatedEventName

ProjectMapUpdateDefinition

ProjectMapUpdatedEventName

RedirectDeleteDefinition

RedirectDeletedEventName

RedirectInsertDefinition

RedirectInsertedEventName

RedirectUpdateDefinition

RedirectUpdatedEventName

ReleaseChangedDefinition

ReleaseChangedEventName

ReleaseCompositionPayloadSchema

ReleaseDeletedDefinition

ReleaseDeletedEventName

ReleaseEntryPayloadSchema

ReleaseLaunchedDefinition

ReleaseLaunchedEventName

ReleaseLaunchStartedDefinition

ReleaseLaunchStartedEventName

ReleasePayloadSchema

webhookEventCatalog

Canonical catalog of internal webhook events, keyed by event name. Each entry is the event's Definition (display name, description, and Zod payload schema).

This is the single source of truth for webhook event names and their payload shapes across the platform: webhook delivery, the dashboard event picker, and Automations that trigger on these events all derive from it. Archived events are intentionally excluded — they are not selectable as triggers.

webhookEventNames

All webhook event names, as a runtime array (catalog key order).

webhookInitiatorSchema

WorkflowEntitySchema

WorkflowReferenceSchema

WorkflowTransitionDefinition

WorkflowTransitionEventName

WorkflowTransitionPayloadSchema

Type Aliases

Type Alias

Description

AssetDeletedPayload

AssetPayload

AssetPublishedPayload

CompositionChangedPayload

CompositionDeletedPayload

CompositionPayload

CompositionPublishedPayload

CompositionReleaseChangedPayload

CompositionReleaseDeletedPayload

CompositionReleasePublishedPayload

CompositionReleaseRestoredPayload

Definition

EntryChangedPayload

EntryDeletedPayload

EntryPayload

EntryPublishedPayload

EntryReleaseChangedPayload

EntryReleaseDeletedPayload

EntryReleasePublishedPayload

EntryReleaseRestoredPayload

ManifestPublishedPayload

NotificationCreatedPayload

NotificationPayload

ProjectMapDeletedPayload

ProjectMapNodeDeletedPayload

ProjectMapNodeInsertedPayload

ProjectMapNodeUpdatedPayload

ProjectMapUpdatedPayload

RedirectDeletedPayload

RedirectInsertedPayload

RedirectUpdatedPayload

ReleaseChangedPayload

ReleaseCompositionPayload

ReleaseDeletedPayload

ReleaseEntryPayload

ReleaseLaunchedPayload

ReleaseLaunchStartedPayload

ReleasePayload

WebhookEventName

Any valid internal webhook event name from the webhookEventCatalog.

WebhookInitiator

WebhookPayloadFor

The payload type delivered for a given webhook event name.

WorkflowTransitionPayload