Get webhooks
curl --request GET \
--url https://api.onswitch.xyz/webhook/history \
--header 'x-service-key: <api-key>'import requests
url = "https://api.onswitch.xyz/webhook/history"
headers = {"x-service-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-service-key': '<api-key>'}};
fetch('https://api.onswitch.xyz/webhook/history', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onswitch.xyz/webhook/history",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-service-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.onswitch.xyz/webhook/history"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-service-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.onswitch.xyz/webhook/history")
.header("x-service-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onswitch.xyz/webhook/history")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-service-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Webhook history fetched successfully",
"timestamp": "2026-04-18T14:22:08.631Z",
"data": {
"data": [
{
"reference": "wh_8k2m9p1q4r7s0t3u6v",
"url": "https://hooks.partner.dev/switch/inbound",
"type": "OFFRAMP",
"status": "SUCCESSFUL",
"request": {
"event": "payment.completed",
"reference": "a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90",
"status": "COMPLETED"
},
"response": {
"received": true,
"http_status": 200
},
"error": null,
"retry_count": 0,
"created_at": "2026-04-18T13:08:45.112Z",
"updated_at": "2026-04-18T13:08:45.418Z"
}
],
"page": 1,
"limit": 10,
"total": 384,
"pages": 39
}
}{
"success": false,
"message": "amount must be greater than 0 for the selected corridor",
"timestamp": "2026-04-18T14:22:08.631Z",
"data": null
}Get webhooks
Returns paginated webhooks history.
GET
/
webhook
/
history
Get webhooks
curl --request GET \
--url https://api.onswitch.xyz/webhook/history \
--header 'x-service-key: <api-key>'import requests
url = "https://api.onswitch.xyz/webhook/history"
headers = {"x-service-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-service-key': '<api-key>'}};
fetch('https://api.onswitch.xyz/webhook/history', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.onswitch.xyz/webhook/history",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-service-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.onswitch.xyz/webhook/history"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-service-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.onswitch.xyz/webhook/history")
.header("x-service-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onswitch.xyz/webhook/history")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-service-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Webhook history fetched successfully",
"timestamp": "2026-04-18T14:22:08.631Z",
"data": {
"data": [
{
"reference": "wh_8k2m9p1q4r7s0t3u6v",
"url": "https://hooks.partner.dev/switch/inbound",
"type": "OFFRAMP",
"status": "SUCCESSFUL",
"request": {
"event": "payment.completed",
"reference": "a3f9c2e1-7b4d-4a8e-9c62-1d8f4e6b2a90",
"status": "COMPLETED"
},
"response": {
"received": true,
"http_status": 200
},
"error": null,
"retry_count": 0,
"created_at": "2026-04-18T13:08:45.112Z",
"updated_at": "2026-04-18T13:08:45.418Z"
}
],
"page": 1,
"limit": 10,
"total": 384,
"pages": 39
}
}{
"success": false,
"message": "amount must be greater than 0 for the selected corridor",
"timestamp": "2026-04-18T14:22:08.631Z",
"data": null
}Authorizations
Service key for API authentication
Query Parameters
Filter by webhook type
Available options:
OFFRAMP, ONRAMP, SWAP, RECEIVE, SEND Filter by status
Available options:
SUCCESSFUL, FAILED Filter by reference or keyword
Maximum string length:
200Filter by start date e.g 2026-01-01
Filter by end date e.g 2026-01-01
Results page number. Default 1.
Required range:
x >= 1Results per page. Default 10, maximum 100.
Required range:
1 <= x <= 100Response
Webhook history retrieved successfully
Hide child attributes
Hide child attributes
Webhook records for the current page
Hide child attributes
Hide child attributes
Identifier for this webhook
Available options:
OFFRAMP, ONRAMP, SWAP, WALLET Status of the webhook
Available options:
SUCCESSFUL, FAILED Request body sent to the developer URL
Response body received from the webhook URL
Required range:
x >= 0Results page number. Default 1.
Results per page. Default 10, maximum 100.
Total matching webhooks (all pages)
Total number of pages for the current limit
⌘I