@cfxlabsinc/b2b-services
    Preparing search index...

    Interface HookdeckHandlerArgs

    interface HookdeckHandlerArgs {
        auth?: HookdeckDestinationAuth;
        cliPath?: Input<string>;
        description?: Input<string>;
        extraRules?: ConnectionRule[];
        filter?: ConnectionRule;
        importConnectionId?: string;
        importDestinationId?: string;
        name?: Input<string>;
        pendingRemoval?: boolean;
        provider: Provider;
        rateLimit?: { count: number; period: HookdeckRateLimitPeriod };
        retry?: false | Partial<ConnectionRuleRetryRule>;
        sourceId: Input<string>;
        transformationId?: Input<string>;
        url?: Input<string>;
    }
    Index
    auth? cliPath? description? extraRules? filter? importConnectionId? importDestinationId? name? pendingRemoval? provider rateLimit? retry? sourceId transformationId? url?
    auth?: HookdeckDestinationAuth

    Credential Hookdeck presents to the destination.

    cliPath?: Input<string>

    Path for a CLI destination, which backs hookdeck listen during local development rather than any deployed service. Mutually exclusive with url.

    description?: Input<string>

    Optional description carried onto both Hookdeck objects.

    extraRules?: ConnectionRule[]

    Escape hatch for rules the typed arguments don't cover (delay, dedupe). Appended after the standard rules.

    filter?: ConnectionRule

    Delivery filter. Build with eventFilter / bodyFilter / headerFilter.

    importConnectionId?: string

    Live connection id to adopt instead of creating. See adoptOpts.

    importDestinationId?: string

    Live destination id to adopt instead of creating. See adoptOpts.

    name?: Input<string>

    Name for both the destination and the connection. Defaults to the component name.

    pendingRemoval?: boolean

    Drop protect on BOTH the destination and the connection so the next change can delete this handler. See adoptOpts — it has to ship one release ahead of the removal.

    provider: Provider

    Hookdeck provider — carries the API key, and therefore the account.

    rateLimit?: { count: number; period: HookdeckRateLimitPeriod }

    Throttle Hookdeck's delivery rate, e.g. {count: 1, period: "concurrent"}.

    retry?: false | Partial<ConnectionRuleRetryRule>

    Retry policy. Defaults to DEFAULT_RETRY_RULE; pass overrides to adjust, or false for a connection that must not retry.

    sourceId: Input<string>

    Source to read from — HookdeckSource.id, or a StackReference output.

    transformationId?: Input<string>

    Transformation applied before delivery — typically injecting service auth headers.

    url?: Input<string>

    Destination URL. Prefer deriving this from the serving stack's own domain output over hardcoding it. Mutually exclusive with cliPath.

    Settings
    Member Visibility

    On This Page
    Properties