Skip to main content
PATCH
Update 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

Path Parameters

webhookId
string
required

Body

application/json
url
string<uri>

Webhook destination URL.

events
enum<string>[]

Replaces the event selection. New subscriptions must use V3 event names. Supported legacy names may be retained only when already subscribed on 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,
customer.verification_changed,
customer.rail.status_changed,
customer.rail.bank_status_changed,
customer.rail.documents_requested,
transfer.created,
transfer.state_changed,
transfer.updated,
transfer.funded_partial,
transfer.completed,
transfer.failed,
transfer.amount_adjusted,
payin.created,
payin.updated,
payin.completed,
payin.failed,
payin.funded_partial,
payin.amount_adjusted,
payout.created,
payout.updated,
payout.completed,
payout.failed,
payout.amount_adjusted

Response

Webhook endpoint updated

data
object
required