Mayson Monorepo Documentation
    Preparing search index...

    Interface WebhookEndpointCreateParams

    interface WebhookEndpointCreateParams {
        enabled_events: Stripe.WebhookEndpointCreateParams.EnabledEvent[];
        url: string;
        api_version?: ApiVersion;
        connect?: boolean;
        description?: string;
        expand?: string[];
        metadata?: Emptyable<MetadataParam>;
    }
    Index

    Properties

    The list of events to enable for this endpoint. You may specify ['*'] to enable all events, except those that require explicit selection.

    url: string

    The URL of the webhook endpoint.

    api_version?: ApiVersion

    Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version.

    connect?: boolean

    Whether this endpoint should receive events from connected accounts (true), or from your account (false). Defaults to false.

    description?: string

    An optional description of what the webhook is used for.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.