Webhook

A Webhook Endpoint sends selected events to its configured URL.

The response reports the exact subscribed event identifiers, payload version, and whether Connected-Account Delivery is enabled.

  • id
    Type: string
    max length:  
    100

    Unique identifier for the object.

  • created
    Type: stringFormat: date-time

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

  • name
    Type: string
    max length:  
    5000

    The webhook's name.

  • url
    Type: string
    max length:  
    5000

    The URL of the webhook endpoint.

  • status
    Type: WebhookStatusenum

    Current lifecycle status of the Webhook Endpoint.

    values
    • active

      The endpoint can receive subscribed events.

    • inactive

      The endpoint is inactive and does not receive events.

  • api_version
    Type: WebhookAPIVersionenum

    Payload schema version used for events delivered to this endpoint.

    values
    • v1

      Legacy Checkout Session and Payment Intent payload shapes. Used when api_version is omitted for backward compatibility.

    • v2

      Recommended for new integrations. Uses the current Checkout Session and Payment Intent resource shapes.

  • connect
    Type: boolean

    Whether this endpoint also receives selected events from accounts connected to the platform account.

  • enabled_events
    Type: array of WebhookEventTypeenum

    Exact event identifiers this endpoint receives.

  • secret
    Type: string
    max length:  
    5000

    The endpoint's secret, used to generate webhook signatures.