Configure webhooks

Introduction

Webhooks allow you to receive real-time notifications about events that happen in your Swipelux account. This enables you to build event-driven integrations that react to changes in your customers' data, transfers, and more.

While webhooks are a great way to stay informed about events, we recommend using them as a notification system rather than the sole source of truth. Always verify the state by making a fresh request to our REST API when you receive a webhook event.

Configure your webhook endpoint

To start receiving webhook events, you need to configure your webhook endpoint URL. Make a PATCH request to the /v1/webhooks endpoint:

curl https://wallet.swipelux.com/v1/webhooks \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: YOUR_SECRET_API_KEY' \
  --data '{
    "url": "https://your-domain.com/webhook"
  }'

This call returns a webhook secret key in the response that you'll need to validate incoming webhook requests:

Response body

{
  "url": "https://your-domain.com/webhook",
  "secretKey": "8af2505e2623dbcc590c2..."
}

Store this secret key securely - you'll need it to verify the signatures of incoming webhook requests.

Your webhook endpoint must be publicly accessible and use HTTPS. We will not send webhooks to non-HTTPS endpoints.

Introduction

Configure your webhook endpoint

Further reading

Handle webhook deliveries

Validate webhook deliveries

On this page