Skip to main content
GET
/
history
/
webhooks
Get webhooks
curl --request GET \
  --url https://api.onswitch.xyz/history/webhooks \
  --header 'x-service-key: <api-key>'
{
  "success": true,
  "message": "<string>",
  "timestamp": "2023-11-07T05:31:56Z",
  "data": {
    "data": [
      {
        "reference": "<string>",
        "url": "<string>",
        "type": "OFFRAMP",
        "status": "SUCCESSFUL",
        "request": {},
        "response": {},
        "error": "<string>",
        "retry_count": 1,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      }
    ],
    "page": 123,
    "limit": 123,
    "total": 123,
    "pages": 123
  }
}

Authorizations

​
x-service-key
string
header
required

Service key for API authentication

Query Parameters

​
type
enum<string>

Filter by webhook type

Available options:
OFFRAMP,
ONRAMP,
SWAP,
WALLET
​
status
enum<string>

Filter by status

Available options:
SUCCESS,
FAILED
​
search
string

Filter by reference or keyword

Maximum string length: 200
​
start_date
string<date-time>

Filter by start date e.g 2026-01-01

​
end_date
string<date-time>

Filter by end date e.g 2026-01-01

​
page
integer
default:1

Results page number. Default 1.

Required range: x >= 1
​
limit
integer
default:10

Results per page. Default 10, maximum 100.

Required range: 1 <= x <= 100

Response

Webhook history retrieved successfully

​
success
boolean
required
​
message
string
required
​
timestamp
string<date-time>
required
​
data
object
required