Webhook Endpoints
Create webhook endpoints to receive real-time notifications of the user's settled invoices.
Last updated
Create webhook endpoints to receive real-time notifications of the user's settled invoices.
Last updated
Your bitcoin & nostr companion / from 🐝 with 🧡
Want to use webhooks for your own Alby account? create a webhook in our developer dashboard
Scope needed: invoices:read
Creates a new webhook endpoint to receive notifications of settled invoices. Settled invoices are sent to the provided url
as a POST request. Requests are sent with SVIX.
The endpoint_secret
in the response body should be saved by the client in order to verify webhook posts to url
. See the SVIX documentation on how to verify requests.
POST
https://api.getalby.com/webhook_endpoints
Creates a new webhook endpoint.
Name | Type | Description |
---|---|---|
Scope needed: invoices:read
Get details about a created webhook endpoint.
GET
https://api.getalby.com/webhook_endpoints/{id}
Gets a webhook endpoint.
Scope needed: invoices:read
Delete a webhook endpoint to stop receiving notifications of settled invoices.
DELETE
https://api.getalby.com/webhook_endpoints/{id}
Deletes a webhook endpoint.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
description
String
url*
String
Webhook URL
filter_types*
String[]
One or more invoice event types to filter webhook events. Supported values are ["invoice.incoming.settled", "invoice.outgoing.settled"]
id*
String
The id of the webhook endpoint
id*
String
The id of the webhook endpoint