Skip to main content
GET
/
subscribed-events
Get subscribed events
curl --request GET \
  --url https://ramp-sandbox.hexarails.ai/subscribed-events \
  --header 'X-API-Key: <api-key>'
{
  "status": "SUCCESS",
  "data": {
    "events": [
      "CUSTOMER_APPROVED",
      "CUSTOMER_REJECTED",
      "CUSTOMER_DELETED",
      "VIRTUAL_ACCOUNT_APPROVED",
      "VIRTUAL_ACCOUNT_REJECTED",
      "DEPOSIT_ADDRESS_APPROVED",
      "DEPOSIT_ADDRESS_REJECTED",
      "DEPOSIT_RECEIVED",
      "DEPOSIT_APPROVED",
      "DEPOSIT_REJECTED",
      "TRADE_CREATED",
      "TRADE_SETTLED",
      "PAYMENT_SETTLED"
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

Response

Get subscribed events successful.

Event Payload Structures:

See WebhookEvent schema (new events) and WebhookEventOld schema (old events) for detailed payload structures for each event type.

​
status
enum<string>
required

Success response status

Available options:
SUCCESS
Example:

"SUCCESS"

​
data
object
required

Response data