WebhookEndpointCreateRequest

Parameters for creating a Webhook Endpoint.

  • name
    Type: string
    max length:  
    5000
    required

    Name to help identify the webhook.

  • url
    Type: string
    max length:  
    5000
    required

    The URL of the webhook endpoint.

  • enabled_events
    Type: array of WebhookEventTypeenum
    required

    Exact event identifiers this endpoint receives. Wildcards are not accepted.

  • api_version
    Type: WebhookAPIVersionenum

    Payload schema version used for event delivery. If omitted, Paypercut uses v1.

    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 the endpoint also receives selected events from accounts connected to the platform account. If omitted, Paypercut uses false.