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

    Interface HookdeckSourceArgs

    interface HookdeckSourceArgs {
        auth?: HookdeckSourceAuth;
        config?: Input<Record<string, unknown>>;
        description?: Input<string>;
        importId?: string;
        name: Input<string>;
        pendingRemoval?: boolean;
        provider: Provider;
        type?: Input<string>;
    }
    Index
    auth? config? description? importId? name pendingRemoval? provider type?
    auth?: HookdeckSourceAuth

    Inbound verification. Omit only when the upstream cannot sign its requests; an unauthenticated source accepts anything that knows the URL.

    config?: Input<Record<string, unknown>>

    Source-level configuration. Rarely needed — most CFX sources set nothing.

    description?: Input<string>

    Optional description carried onto the Hookdeck object.

    importId?: string

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

    Applies to the source only — hookdeck_source_auth has no id and no import support in the provider, so the auth is always (re)applied from Doppler.

    name: Input<string>

    Human-friendly name, unique within the Hookdeck account.

    pendingRemoval?: boolean

    Drop protect so the NEXT change can delete this declaration. See adoptOpts — it has to ship one release ahead of the removal.

    provider: Provider

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

    type?: Input<string>

    Hookdeck source type. Defaults to a generic HTTP source; set it for providers Hookdeck models natively, e.g. "AIPRISE" or "SVIX", which changes how Hookdeck parses and verifies the payload.

    Settings
    Member Visibility

    On This Page
    Properties