Events

List all organization events

Stripe-style 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, or webhook.test
accountId — events for one trading account

Example:

GET /platform/v1/organization/events?eventType=account.failed&limit=25
X-API-Key: hp_live_...

Permissions: requires view access to “Webhooks”.

Authentication: send your organization API key in the X-API-Key header.

GET

organization

events

List all organization events

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/events \
  --header 'X-API-Key: <api-key>'

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))

}

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,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "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"
}

Authorizations

X-API-Key

string

header

required

Organization API key. Format: "hp_live_{key}". Organization admins manage the key in the dashboard.

Query Parameters

eventType

string

Filter by event type (API names, e.g. account.failed, or webhook.test)

accountId

string

Filter to events of one trading account

limit

integer

default:50

Required range: 1 <= x <= 100

offset

integer

default:0

Required range: x >= 0

Response

Paginated event feed, newest first

success

boolean

Example:

true

data

object

Show child attributes

⌘I

List all organization events

curl --request GET \
  --url https://api.hyperprop.com/platform/v1/organization/events \
  --header 'X-API-Key: <api-key>'

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))

}

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,
      "limit": 50,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "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"
}

Platform API

Trade API

List all organization events

Authorizations

Query Parameters

Response