Webhook

You can configure via the API to be notified about events that happen in your account. Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

  • 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.

  • enabled_events
    Type: array string[] · WebhookEventType[]enum

    The event types this endpoint receives.

    values
    • checkout_session.completed
    • payment_intent.authorized
    • payment_intent.captured
    • account.updated
    • account.external_account.created
    • account.external_account.updated
    • invoice.paid
    • invoice.payment_failed
    • Type: string · WebhookEventTypeenum

      Event types that webhook endpoints can subscribe to.

      values
      • checkout_session.completed

        A Checkout Session completed successfully.

      • payment_intent.authorized

        A PaymentIntent was authorized and can be captured.

      • payment_intent.captured

        A PaymentIntent was captured.

      • account.updated

        A connected account was updated.

      • account.external_account.created

        An external account was attached to a connected account.

      • account.external_account.updated

        An external account on a connected account was updated.

      • invoice.paid

        An invoice was paid.

      • invoice.payment_failed

        An invoice payment failed.

  • status
    Type: string
    max length:  
    5000

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

  • secret
    Type: string
    max length:  
    5000

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