Skip to main content
POST
/
v1
/
webhooks
Create webhook
curl --request POST \
  --url https://api.ledger.so/v1/webhooks \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "description": "<string>",
  "events": [
    "<string>"
  ]
}
'
{
  "object": "webhook",
  "id": "<string>",
  "url": "<string>",
  "events": [
    "<string>"
  ],
  "status": "enabled",
  "createdAt": 123,
  "updatedAt": 123,
  "description": "<string>",
  "secret": "<string>"
}

Authorizations

​
Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Body

application/json
​
url
string<uri>
required

The URL to send webhook events to

​
description
string

A description of the webhook endpoint

​
events
string[]

List of event types to subscribe to. Omit to receive all events.

Response

Webhook created

​
object
enum<string>
required
Available options:
webhook
​
id
string
required

Unique identifier for the webhook endpoint

​
url
string<uri>
required

The URL to send webhook events to

​
events
string[]
required

List of event types to subscribe to. Empty array means all events.

​
status
enum<string>
required

Whether the webhook endpoint is active

Available options:
enabled,
disabled
​
createdAt
integer
required

Unix timestamp when the webhook was created

​
updatedAt
integer
required

Unix timestamp when the webhook was last updated

​
description
string

A description of the webhook endpoint

​
secret
string

The signing secret for verifying webhook payloads. Only returned on creation.