webhook_create_spec3.toml

[paths."/v1/webhook_endpoints".post]
description = "<p>A webhook endpoint must have a <code>url</code> and a list of <code>enabled_events</code>. You may optionally specify the Boolean <code>connect</code> parameter. If set to true, then a Connect webhook endpoint that notifies the specified <code>url</code> about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified <code>url</code> only about events from your account is created. You can also create webhook endpoints in the <a href=\"https://dashboard.stripe.com/account/webhooks\">webhooks settings</a> section of the Dashboard.</p>"
operationId = "NotificationWebhookEndpointCreate"

[paths."/v1/webhook_endpoints".post.requestBody]
required = true

[paths."/v1/webhook_endpoints".post.requestBody.content]

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded"]

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".encoding]

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".encoding.enabled_events]
explode = true
style = "deepObject"

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".encoding.expand]
explode = true
style = "deepObject"

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".schema]
additionalProperties = false
required = ["enabled_events", "url"]
type = "object"

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".schema.properties]

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".schema.properties.connect]
description = "Whether this endpoint should receive events from connected accounts (`true`), or your account (`false`)."
type = "boolean"

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".schema.properties.enabled_events]
description = "The list of events to enable for this endpoint. You may specify `['*']` to enable all events."
type = "array"

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".schema.properties.enabled_events.items]
enum = ["*", "account.application.authorized", "account.application.deauthorized", "account.approaching_unactivated_threshold", "account.exceeded_unactivated_threshold", "account.external_account.created", "account.external_account.deleted", "account.external_account.updated", "account.need_info", "account.need_info.resolved", "account.note_for_review", "account.note_for_review.resolved", "account.reject", "account.reject.resolved", "account.risk_transfers_disabled", "account.updated", "application_fee.created", "application_fee.refund.updated", "application_fee.refunded", "balance.available", "balance.stripe_reserve_canceled", "balance.stripe_reserve_created", "balance.stripe_reserve_expired", "batch.created", "batch.updated", "capability.created", "capability.updated", "charge.captured", "charge.dispute.closed", "charge.dispute.created", "charge.dispute.funds_reinstated", "charge.dispute.funds_withdrawn", "charge.dispute.updated", "charge.expired", "charge.failed", "charge.pending", "charge.refund.updated", "charge.refunded", "charge.succeeded", "charge.updated", "checkout_beta.session_succeeded", "coupon.created", "coupon.deleted", "coupon.updated", "customer.bank_account.created", "customer.bank_account.deleted", "customer.bank_account.updated", "customer.card.contact_cardholder", "customer.card.created", "customer.card.deleted", "customer.card.updated", "customer.created", "customer.deleted", "customer.discount.created", "customer.discount.deleted", "customer.discount.updated", "customer.payment_method.created", "customer.payment_method.deleted", "customer.payment_method.updated", "customer.source.contact_cardholder", "customer.source.created", "customer.source.deleted", "customer.source.expiring", "customer.source.updated", "customer.subscription.created", "customer.subscription.deleted", "customer.subscription.trial_will_end", "customer.subscription.updated", "customer.updated", "file.created", "invoice.created", "invoice.deleted", "invoice.finalized", "invoice.marked_uncollectible", "invoice.payment_failed", "invoice.payment_succeeded", "invoice.sent", "invoice.upcoming", "invoice.updated", "invoice.voided", "invoiceitem.created", "invoiceitem.deleted", "invoiceitem.updated", "issuer_fraud_record.created", "issuing_authorization.created", "issuing_authorization.request", "issuing_authorization.updated", "issuing_card.created", "issuing_card.updated", "issuing_cardholder.created", "issuing_cardholder.updated", "issuing_dispute.created", "issuing_dispute.updated", "issuing_transaction.created", "issuing_transaction.updated", "order.created", "order.payment_failed", "order.payment_succeeded", "order.updated", "order_return.created", "payment.created", "payment.failed", "payment.paid", "payment_intent.amount_capturable_updated", "payment_intent.created", "payment_intent.payment_failed", "payment_intent.requires_capture", "payment_intent.succeeded", "payment_provider_balance_transaction.created", "payment_provider_transfer.updated", "payout.canceled", "payout.created", "payout.failed", "payout.paid", "payout.updated", "person.created", "person.deleted", "person.updated", "ping", "plan.created", "plan.deleted", "plan.updated", "product.created", "product.deleted", "product.updated", "recipient.card.created", "recipient.card.deleted", "recipient.card.updated", "recipient.created", "recipient.deleted", "recipient.updated", "recipient_transfer.canceled", "recipient_transfer.created", "recipient_transfer.failed", "recipient_transfer.paid", "recipient_transfer.updated", "refund.created", "refund.failed", "reporting.report_run.failed", "reporting.report_run.succeeded", "reporting.report_run.updated", "reporting.report_type.updated", "review.closed", "review.opened", "sigma.scheduled_query_run.created", "sku.created", "sku.deleted", "sku.updated", "source.canceled", "source.chargeable", "source.failed", "source.mandate_notification", "source.refund_attributes_required", "source.transaction.created", "source.transaction.updated", "subscription_schedule.canceled", "subscription_schedule.completed", "subscription_schedule.created", "subscription_schedule.released", "subscription_schedule.updated", "topup.canceled", "topup.created", "topup.failed", "topup.reversed", "topup.succeeded", "transfer.canceled", "transfer.created", "transfer.failed", "transfer.paid", "transfer.reversed", "transfer.updated"]
maxLength = 5000
type = "string"

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".schema.properties.expand]
description = "Specifies which fields in the response should be expanded."
type = "array"

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".schema.properties.expand.items]
maxLength = 5000
type = "string"

[paths."/v1/webhook_endpoints".post.requestBody.content."application/x-www-form-urlencoded".schema.properties.url]
description = "The URL of the webhook endpoint."
type = "string"

[paths."/v1/webhook_endpoints".post.responses]

[paths."/v1/webhook_endpoints".post.responses.200]
description = "Successful response."

[paths."/v1/webhook_endpoints".post.responses.200.content]

[paths."/v1/webhook_endpoints".post.responses.200.content."application/json"]

[paths."/v1/webhook_endpoints".post.responses.200.content."application/json".schema]
"$ref" = "#/components/schemas/webhook_endpoint"

[paths."/v1/webhook_endpoints".post.responses.default]
description = "Error response."

[paths."/v1/webhook_endpoints".post.responses.default.content]

[paths."/v1/webhook_endpoints".post.responses.default.content."application/json"]

[paths."/v1/webhook_endpoints".post.responses.default.content."application/json".schema]
"$ref" = "#/components/schemas/error"