Mayson Monorepo Documentation
    Preparing search index...

    Interface WebhookEndpointUpdateParams

    interface WebhookEndpointUpdateParams {
        description?: string;
        disabled?: boolean;
        enabled_events?: Stripe.WebhookEndpointUpdateParams.EnabledEvent[];
        expand?: string[];
        metadata?: Emptyable<MetadataParam>;
        url?: string;
    }
    Index

    Properties

    description?: string

    An optional description of what the webhook is used for.

    disabled?: boolean

    Disable the webhook endpoint if set to true.

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

    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.

    url?: string

    The URL of the webhook endpoint.