User GuideDeveloper Portal

Webhook Endpoints

Create webhook endpoints to receive real-time notifications of the user's settled invoices.

Want to use webhooks for your own Alby account? create a webhook in our developer dashboard

Create a webhook endpoint

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.

Request Body

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"]

{
    "url": "https://webhook.site/2d10f6a2-8860-48af-8c25-379a3c921d30",
    "description": "An example endpoint",
    "filter_types": [
        "invoice.settled"
    ],
    "created_at": "2023-05-02T07:35:03.867Z",
    "id": "ep_2PECYp6CLXBbAqyFnhbxFUXM2ZR",
    "endpoint_secret": "whsec_QE8DIo3EtwlPmkOGCmxYyAcAxnpArzP/"
}
Example webhook POST payload (Settled Invoice)
Example webhook POST payload (Keysend payment)

Get a webhook endpoint

Scope needed: invoices:read

Get details about a created webhook endpoint.

GET https://api.getalby.com/webhook_endpoints/{id}

Gets a webhook endpoint.

Path Parameters

Name
Type
Description

id*

String

The id of the webhook endpoint

Delete 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.

Path Parameters

Name
Type
Description

id*

String

The id of the webhook endpoint

Last updated

Was this helpful?