Mayson Monorepo Documentation
    Preparing search index...

    You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

    Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

    Related guide: Setting up webhooks

    interface WebhookEndpoint {
        id: string;
        object: "webhook_endpoint";
        api_version: string;
        application: string;
        created: number;
        deleted?: void;
        description: string;
        enabled_events: string[];
        livemode: boolean;
        metadata: Metadata;
        secret?: string;
        status: string;
        url: string;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "webhook_endpoint"

    String representing the object's type. Objects of the same type share the same value.

    api_version: string

    The API version events are rendered as for this webhook endpoint.

    application: string

    The ID of the associated Connect application.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    deleted?: void

    Always true for a deleted object

    description: string

    An optional description of what the webhook is used for.

    enabled_events: string[]

    The list of events to enable for this endpoint. ['*'] indicates that all events are enabled, except those that require explicit selection.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    metadata: Metadata

    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.

    secret?: string

    The endpoint's secret, used to generate webhook signatures. Only returned at creation.

    status: string

    The status of the webhook. It can be enabled or disabled.

    url: string

    The URL of the webhook endpoint.