Anchorage API reference
    Preparing search index...

    Interface WebhookSignalProviderConfig

    Config for the generic webhook provider — the core WebhookSignalProvider knobs (extractResourceId, buildNotification) PLUS the signature check core omits (a generic webhook has no signing scheme; a real one — GitHub — does).

    interface WebhookSignalProviderConfig {
        buildNotification: (
            payload: unknown,
            subscription: SignalSubscription,
        ) => SendNotificationSignalInput;
        extractResourceIds?: (payload: unknown) => string | string[] | undefined;
        id: string;
        name?: string;
        pollForDeliveries?: (
            subscriptions: SignalSubscription[],
        ) => Promise<ProviderDelivery[]>;
        pollInterval?: number;
        verifyWebhookSignature?: (
            rawBody: Uint8Array,
            headers: WebhookHeaders,
            secret: string,
        ) => boolean | Promise<boolean>;
    }
    Index

    Properties

    buildNotification extractResourceIds? id name? pollForDeliveries? pollInterval? verifyWebhookSignature?

    Properties

    buildNotification: (
        payload: unknown,
        subscription: SignalSubscription,
    ) => SendNotificationSignalInput

    Build the notification a matched subscription receives (REQUIRED — both paths).

    extractResourceIds?: (payload: unknown) => string | string[] | undefined

    The external-resource key(s) an incoming payload concerns (webhook providers).

    id: string
    name?: string
    pollForDeliveries?: (
        subscriptions: SignalSubscription[],
    ) => Promise<ProviderDelivery[]>

    Poll seam (poll providers). Omit ⇒ webhook-only (no host-DO alarm).

    pollInterval?: number

    Optional poll cadence; a pure webhook provider omits it.

    verifyWebhookSignature?: (
        rawBody: Uint8Array,
        headers: WebhookHeaders,
        secret: string,
    ) => boolean | Promise<boolean>

    Signature check (webhook providers). Omit ⇒ the provider accepts no webhooks.

    Settings

    Member Visibility

    On This Page

    Properties