Skip to main content
POST
/
v1
/
webhook_endpoints
Create a WebhookEndpoint
curl --request POST \
  --url https://api.leanrails.com/v1/webhook_endpoints \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "url": "<string>",
  "enabled_events": [
    "balance.available"
  ],
  "description": "<string>"
}
'
{
  "id": "we_xxx",
  "object": "webhook_endpoint",
  "url": "https://example.com/webhook",
  "enabled_events": [
    "payment_intent.succeeded"
  ],
  "status": "enabled",
  "created": 1234567890,
  "livemode": false,
  "merchant_id": "mer_xxx",
  "secret": "whsec_xxx",
  "description": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.fluveo.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Use your secret API key as the username with an empty password.

Headers

​
Idempotency-Key
string
required

Unique key to ensure idempotent requests.

Maximum string length: 255
​
X-API-Version
string

Override the API version for this request.

Body

application/json
​
url
string<uri>
required

The URL to receive webhook events.

​
enabled_events
enum<string>[]
required

The list of event types to subscribe to.

Minimum array length: 1
Available options:
balance.available,
charge.dispute.closed,
charge.dispute.created,
charge.dispute.updated,
charge.failed,
charge.refunded,
charge.succeeded,
checkout.session.completed,
checkout.session.expired,
checkout_link.created,
checkout_link.updated,
collection.created,
collection.deleted,
collection.updated,
conversion_tracking.config.error,
customer.created,
customer.deleted,
customer.subscription.created,
customer.subscription.deleted,
customer.subscription.past_due,
customer.subscription.resumed,
customer.subscription.trial_will_end,
customer.subscription.updated,
customer.updated,
dispute.closed,
dispute.created,
dispute.evidence.required,
dispute.updated,
fulfillment.canceled,
fulfillment.created,
fulfillment.delivered,
fulfillment.shipped,
fulfillment.updated,
inventory_item.updated,
inventory_level.updated,
invoice.created,
invoice.finalized,
invoice.marked_uncollectible,
invoice.paid,
invoice.payment_failed,
invoice.upcoming,
invoice.voided,
merchant.verification.approved,
merchant.verification.rejected,
merchant.verification.started,
order.canceled,
order.created,
order.fulfilled,
order.paid,
order.payment_failed,
order.refunded,
order.returned,
order.updated,
payment_intent.canceled,
payment_intent.created,
payment_intent.payment_failed,
payment_intent.requires_action,
payment_intent.succeeded,
payout.canceled,
payout.created,
payout.failed,
payout.paid,
payout.updated,
price.created,
price.deleted,
price.updated,
product.created,
product.deleted,
product.updated,
promotion.created,
promotion.deleted,
promotion.updated,
refund.created,
refund.failed,
refund.updated,
settlement.batch.completed,
setup_intent.created,
setup_intent.setup_failed,
setup_intent.succeeded,
subscription.created,
subscription.deleted,
subscription.past_due,
subscription.resumed,
subscription.trial_will_end,
subscription.updated,
transfer.created,
transfer.reversed,
transfer.updated
​
description
string

Response

The created WebhookEndpoint (includes the secret in plaintext).

​
id
string
required
Example:

"we_xxx"

​
object
enum<string>
required
Available options:
webhook_endpoint
​
url
string<uri>
required
Example:

"https://example.com/webhook"

​
enabled_events
enum<string>[]
required
Available options:
balance.available,
charge.dispute.closed,
charge.dispute.created,
charge.dispute.updated,
charge.failed,
charge.refunded,
charge.succeeded,
checkout.session.completed,
checkout.session.expired,
checkout_link.created,
checkout_link.updated,
collection.created,
collection.deleted,
collection.updated,
conversion_tracking.config.error,
customer.created,
customer.deleted,
customer.subscription.created,
customer.subscription.deleted,
customer.subscription.past_due,
customer.subscription.resumed,
customer.subscription.trial_will_end,
customer.subscription.updated,
customer.updated,
dispute.closed,
dispute.created,
dispute.evidence.required,
dispute.updated,
fulfillment.canceled,
fulfillment.created,
fulfillment.delivered,
fulfillment.shipped,
fulfillment.updated,
inventory_item.updated,
inventory_level.updated,
invoice.created,
invoice.finalized,
invoice.marked_uncollectible,
invoice.paid,
invoice.payment_failed,
invoice.upcoming,
invoice.voided,
merchant.verification.approved,
merchant.verification.rejected,
merchant.verification.started,
order.canceled,
order.created,
order.fulfilled,
order.paid,
order.payment_failed,
order.refunded,
order.returned,
order.updated,
payment_intent.canceled,
payment_intent.created,
payment_intent.payment_failed,
payment_intent.requires_action,
payment_intent.succeeded,
payout.canceled,
payout.created,
payout.failed,
payout.paid,
payout.updated,
price.created,
price.deleted,
price.updated,
product.created,
product.deleted,
product.updated,
promotion.created,
promotion.deleted,
promotion.updated,
refund.created,
refund.failed,
refund.updated,
settlement.batch.completed,
setup_intent.created,
setup_intent.setup_failed,
setup_intent.succeeded,
subscription.created,
subscription.deleted,
subscription.past_due,
subscription.resumed,
subscription.trial_will_end,
subscription.updated,
transfer.created,
transfer.reversed,
transfer.updated
Example:
["payment_intent.succeeded"]
​
status
enum<string>
required
Available options:
enabled,
disabled
​
created
integer
required
Example:

1234567890

​
livemode
boolean
required
Example:

false

​
merchant_id
string
Example:

"mer_xxx"

​
secret
string

The signing secret. Only returned in full on creation; masked on retrieval.

Example:

"whsec_xxx"

​
description
string | null