List all organization events
Event feed: every event that happened in your organization,
newest first — including events no webhook was subscribed to (those simply
have an empty deliveries array) and manual webhook.test events.
Each event carries a deliverySummary and the per-endpoint deliveries
so you can see at a glance whether an event reached your servers.
Difference vs /webhook-deliveries: that endpoint lists deliveries
(one row per event per webhook). This endpoint lists events (one row per
event, with its deliveries nested). Use this one to answer “what happened?”,
use /webhook-deliveries to answer “what did we send to endpoint X?”.
Filters:
eventType— e.g.account.failed,account.payout_processed, orwebhook.testaccountId— events for one trading account
Example:
GET /platform/v1/organization/events?eventType=account.failed&limit=25
X-API-Key: hp_live_...
Pagination: pagination.total counts matching items up to 10,000 (or up
to the end of the requested page, if that is further). When more match,
total is that limit and pagination.totalCapped is true — show it as
“10,000+”. hasMore stays accurate either way; page with offset until it
is false.
Permissions: requires view access to “Webhooks”.
Authentication: send your organization API key in the X-API-Key header.
Access: read-only and full-access API keys. Dashboard members need view access to Webhooks.
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/events \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/events"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/events', 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.hyperprop.com/platform/v1/organization/events",
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-API-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.hyperprop.com/platform/v1/organization/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-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.hyperprop.com/platform/v1/organization/events")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"events": [
{
"id": "4c2c49f0-7f1a-4f40-b333-333333333333",
"type": "account.status_changed",
"accountId": "<string>",
"accountNumber": "HP-50K-001234",
"reason": "Max Loss exceeded: $2,514.00 loss >= $2500 limit",
"trigger": "rule_violation",
"createdAt": "<string>",
"deliveries": [
{
"id": "<string>",
"webhookId": "<string>",
"eventId": "<string>",
"eventType": "account.status_changed",
"endpointUrl": "https://your-server.com/webhooks/hyperprop",
"webhookDescription": "Production webhook",
"status": "delivered",
"httpStatus": 200,
"responseBody": "{\"received\":true}",
"responseHeaders": {},
"responseTime": 245,
"attempt": 1,
"nextRetryAt": "<string>",
"deliveredAt": "<string>",
"createdAt": "<string>",
"attempts": [
{
"id": "<string>",
"attempt": 2,
"status": "delivered",
"httpStatus": 500,
"responseBody": "Internal Server Error",
"responseHeaders": {},
"responseTime": 310,
"attemptedAt": "<string>"
}
]
}
],
"deliverySummary": {
"total": 2,
"delivered": 1,
"failed": 1,
"retrying": 0,
"pending": 0
}
}
],
"pagination": {
"total": 3200,
"totalCapped": false,
"limit": 50,
"offset": 0,
"hasMore": true
}
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}Authorizations
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Query Parameters
curl --request GET \
--url https://api.hyperprop.com/platform/v1/organization/events \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.hyperprop.com/platform/v1/organization/events"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.hyperprop.com/platform/v1/organization/events', 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.hyperprop.com/platform/v1/organization/events",
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-API-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.hyperprop.com/platform/v1/organization/events"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-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.hyperprop.com/platform/v1/organization/events")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/events")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"events": [
{
"id": "4c2c49f0-7f1a-4f40-b333-333333333333",
"type": "account.status_changed",
"accountId": "<string>",
"accountNumber": "HP-50K-001234",
"reason": "Max Loss exceeded: $2,514.00 loss >= $2500 limit",
"trigger": "rule_violation",
"createdAt": "<string>",
"deliveries": [
{
"id": "<string>",
"webhookId": "<string>",
"eventId": "<string>",
"eventType": "account.status_changed",
"endpointUrl": "https://your-server.com/webhooks/hyperprop",
"webhookDescription": "Production webhook",
"status": "delivered",
"httpStatus": 200,
"responseBody": "{\"received\":true}",
"responseHeaders": {},
"responseTime": 245,
"attempt": 1,
"nextRetryAt": "<string>",
"deliveredAt": "<string>",
"createdAt": "<string>",
"attempts": [
{
"id": "<string>",
"attempt": 2,
"status": "delivered",
"httpStatus": 500,
"responseBody": "Internal Server Error",
"responseHeaders": {},
"responseTime": 310,
"attemptedAt": "<string>"
}
]
}
],
"deliverySummary": {
"total": 2,
"delivered": 1,
"failed": 1,
"retrying": 0,
"pending": 0
}
}
],
"pagination": {
"total": 3200,
"totalCapped": false,
"limit": 50,
"offset": 0,
"hasMore": true
}
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "\"limit\" must be less than or equal to 100",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"statusCode": 504,
"error": "Gateway Timeout",
"message": "The request did not complete within 25 seconds. Try again, or narrow it (for example a shorter date range).",
"code": "REQUEST_TIMEOUT"
}