Mayson Monorepo Documentation
    Preparing search index...

    Set up an event destination to receive events from Stripe across multiple destination types, including webhook endpoints and Amazon EventBridge. Event destinations support receiving thin events and snapshot events.

    interface EventDestination {
        id: string;
        object: "v2.core.event_destination";
        amazon_eventbridge?: Stripe.V2.Core.EventDestination.AmazonEventbridge;
        created: string;
        description: string;
        enabled_events: string[];
        event_payload: Stripe.V2.Core.EventDestination.EventPayload;
        events_from?: Stripe.V2.Core.EventDestination.EventsFrom[];
        livemode: boolean;
        metadata?: Metadata;
        name: string;
        snapshot_api_version?: string;
        status: Stripe.V2.Core.EventDestination.Status;
        status_details?: Stripe.V2.Core.EventDestination.StatusDetails;
        type: Stripe.V2.Core.EventDestination.Type;
        updated: string;
        webhook_endpoint?: Stripe.V2.Core.EventDestination.WebhookEndpoint;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "v2.core.event_destination"

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

    Amazon EventBridge configuration.

    created: string

    Time at which the object was created.

    description: string

    An optional description of what the event destination is used for.

    enabled_events: string[]

    The list of events to enable for this endpoint.

    Payload type of events being subscribed to.

    Where events should be routed from.

    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

    Metadata.

    name: string

    Event destination name.

    snapshot_api_version?: string

    If using the snapshot event payload, the API version events are rendered as.

    Status. It can be set to either enabled or disabled.

    Additional information about event destination status.

    Event destination type.

    updated: string

    Time at which the object was last updated.

    Webhook endpoint configuration.