List Webhook Events

List all available webhook events.

Returns all available webhook events you can subscribe to. This endpoint does not require authentication.

Endpoint

GET /v1/webhooks/events

Authentication

None required — this is a public endpoint.

Example request

cURL

curl -X GET https://ramp-api.ivorypay.io/api/v1/webhooks/events

Node.js

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/webhooks/events", {
  method: "GET",
});

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

Python

import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/webhooks/events",
)

print(response.json())

Go

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/webhooks/events", nil)

	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

The response data is an array of EventDescriptor objects with the shape { name, description }.

{
  "success": true,
  "message": "Query successful",
  "data": [
    {
      "name": "onramp.fiatPaymentReceived",
      "description": "Triggered when the fiat payment for an on-ramp transaction has been received"
    },
    {
      "name": "onramp.cryptoPayoutProcessing",
      "description": "Triggered when the crypto payout for an on-ramp transaction is being processed"
    },
    {
      "name": "onramp.success",
      "description": "Triggered when an on-ramp transaction is successful"
    },
    {
      "name": "onramp.failed",
      "description": "Triggered when an on-ramp transaction fails"
    },
    {
      "name": "offramp.cryptoPaymentReceived",
      "description": "Triggered when the crypto payment for an off-ramp transaction has been received"
    },
    {
      "name": "offramp.success",
      "description": "Triggered when an off-ramp transaction is successful"
    },
    {
      "name": "offramp.failed",
      "description": "Triggered when an off-ramp transaction fails"
    },
    {
      "name": "offramp.declined",
      "description": "Triggered when an off-ramp transaction is declined"
    },
    {
      "name": "deposit.received",
      "description": "Triggered when a fiat deposit is received on a virtual account"
    },
    {
      "name": "settlement.awaitingSettlementAccount",
      "description": "Triggered when a settlement is awaiting a settlement account assignment"
    },
    {
      "name": "settlement.converting",
      "description": "Triggered when fiat-to-crypto conversion begins for a settlement"
    },
    {
      "name": "settlement.payoutInitiated",
      "description": "Triggered when a crypto payout is initiated for a settlement"
    },
    {
      "name": "settlement.payoutProcessing",
      "description": "Triggered when a crypto payout is being processed for a settlement"
    },
    {
      "name": "settlement.success",
      "description": "Triggered when a settlement is completed successfully"
    },
    {
      "name": "settlement.failed",
      "description": "Triggered when a settlement fails"
    }
  ]
}

For detailed payload schemas for each event, see Webhook Events Reference.