Skip to main content

Webhooks

Webhook management for wallet/network. Caller must have access to the wallet's node.

Authentication: Bearer token required.


List Webhooks

Endpoint: GET /api/v1/webhooks

Query Parameters

ParameterTypeRequiredDefaultDescription
wallet_idstringNoFilter by wallet UUID
pageintNo1Page number
per_pageintNo10Items per page (max 100)

Response — 200 OK

Paginated list (credentials never included).


Create Webhook

Endpoint: POST /api/v1/webhooks

Request Body

FieldTypeRequiredDescription
wallet_idstringYesWallet UUID
network_idstringYesNetwork UUID
hoststringYesmax 2048
success_pathstringYesmax 512
error_pathstringYesmax 512
auth_typestringYesbasic or token
auth_basic_usernamestringNoFor auth_type=basic
auth_basic_passwordstringNoFor auth_type=basic
auth_tokenstringNoFor auth_type=token

Response — 201 Created

StatusDescription
403No access to wallet's node
404Wallet or network not found
409Conflict

Update Webhook

Endpoint: PUT /api/v1/webhooks

Request Body

FieldTypeRequiredDescription
idstringYesWebhook UUID
hoststringNomax 2048
success_pathstringNomax 512
error_pathstringNomax 512
auth_typestringNobasic or token
auth_basic_usernamestringNo
auth_basic_passwordstringNo
auth_tokenstringNo

Response — 200 OK

StatusDescription
403No access to webhook's wallet node
404Webhook not found

Delete Webhook

Endpoint: DELETE /api/v1/webhooks

Request Body

{ "id": "550e8400-e29b-41d4-a716-446655440000" }

Response — 204 No Content

StatusDescription
403No access to webhook's wallet node
404Webhook not found