Skip to main content
POST
cURL
Send only the fields to change. disabled: true stops deliveries; events that happen while it is off are not sent to it later. After three days of failed deliveries Ledger turns an endpoint off (disabledReason: "failing"). Fix the receiver, then send disabled: false: deliveries that were still retrying resume, and new events are sent again.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Required string length: 1 - 64
Pattern: ^we_[A-Za-z0-9]+$

Body

application/json
url
string

Where Ledger sends events. Live and production endpoints must be public https:// URLs.

Required string length: 1 - 2048
Example:

"https://example.com/webhooks/ledger"

enabledEvents
enum<string>[]
Required array length: 1 - 50 elements

An event type, or * for every event.

Available options:
*,
customer.created,
customer.deleted,
subscription.created,
subscription.updated,
subscription.canceled,
invoice.paid,
credits.granted,
balance.low,
balance.depleted,
checkout.completed,
checkout.expired
description
string | null
Maximum string length: 200
disabled
boolean

true turns the endpoint off. false turns it back on, including after Ledger turned it off for failing.

Response

Endpoint updated

object
enum<string>
required
Available options:
webhook_endpoint
id
string
required
url
string
required
description
string | null
required
enabledEvents
string[]
required
apiVersion
string
required
status
enum<string>
required
Available options:
enabled,
disabled
disabledReason
enum<string> | null
required
Available options:
failing,
manual,
null
disabledAt
string | null
required
failingSince
string | null
required
livemode
boolean
required
environment
enum<string>
required
Available options:
sandbox,
live
createdAt
string
required
updatedAt
string
required