Skip to main content
Create webhook endpoint

Authorizations

X-API-Key
string
header
required

Your Swipelux API key. Obtain this from the Swipelux Dashboard.

Headers

Idempotency-Key
string
required

Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response.

Required string length: 1 - 255

Body

application/json
url
string<uri>
required

Webhook destination URL.

events
enum<string>[]
required

Event types delivered to this endpoint.

Minimum array length: 1

Open enum — values are added over time; clients must tolerate new names appearing in the catalog. Unknown names are rejected at write time against the current catalog.

Available options:
customer.created,
customer.updated,
customer.archived,
capability.created,
capability.status_changed,
application.status_changed,
recipient.status_changed,
destination.status_changed,
account.created,
account.status_changed,
account.details_changed,
api.deprecation,
transfer.created,
transfer.state_changed

Response

Webhook endpoint created

data
object
required