List Webhooks

List all configured webhooks.

Returns all webhooks configured for your business, optionally filtered by environment.

Endpoint

GET /v1/webhooks

Authentication

Header

Value

x-api-key

Your API key

Query parameters

Parameter

Type

Required

Description

environment

string

Filter by TEST or LIVE

Example request

curl -X GET "https://ramp-api.ivorypay.io/api/v1/webhooks?environment=LIVE" \
  -H "x-api-key: your_api_key"

const params = new URLSearchParams({
  environment: "LIVE",
});

const response = await fetch(`https://ramp-api.ivorypay.io/api/v1/webhooks?${params}`, {
  method: "GET",
  headers: {
    "x-api-key": "your_api_key",
  },
});

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/webhooks",
    headers={
        "x-api-key": "your_api_key",
    },
    params={
        "environment": "LIVE",
    },
)

print(response.json())

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/webhooks?environment=LIVE", nil)
	req.Header.Set("x-api-key", "your_api_key")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Example response

{
  "statusCode": 200,
  "success": true,
  "message": "Query successful",
  "data": [
    {
      "id": "wh-uuid-1",
      "url": "https://yourapp.com/webhooks/ivorypay",
      "environment": "LIVE",
      "events": ["onramp.success", "offramp.success", "buy.success", "sell.success"],
      "createdAt": "2026-03-26T12:00:00.000Z"
    }
  ]
}

PreviousSetup Webhook NextUpdate Webhook

Last updated 1 month ago

hashtagEndpoint

hashtagAuthentication

hashtagQuery parameters

hashtagExample request

hashtagExample response

Endpoint

Authentication

Query parameters

Example request

Example response