Webhooks

Inspect a webhook event and all delivery attempts

Stripe-style detail for one webhook delivery.

Returns:

The exact event JSON object sent to the endpoint (payload)
Endpoint URL/description captured at delivery creation time
Current delivery state, HTTP status, response body, sanitized response headers, and latency
Immutable newest-first attempt history, including automatic retries and manual redeliveries
Connection failures and timeouts in responseBody even when no HTTP status exists

Sensitive response headers such as set-cookie and authorization are redacted before storage. Response bodies are capped at 1 KiB.

Use the returned delivery id with POST /organization/webhook-deliveries/{deliveryId}/redeliver after fixing the endpoint.

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

GET

organization

webhook-deliveries

{deliveryId}

Inspect a webhook event and all delivery attempts

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

import requests

url = "https://api.hyperprop.com/platform/v1/organization/webhook-deliveries/{deliveryId}"

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/webhook-deliveries/{deliveryId}', 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/webhook-deliveries/{deliveryId}",
  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/webhook-deliveries/{deliveryId}"

	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/webhook-deliveries/{deliveryId}")

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": {
    "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>",
    "payload": {},
    "attempts": [
      {
        "id": "<string>",
        "attempt": 2,
        "status": "delivered",
        "httpStatus": 500,
        "responseBody": "Internal Server Error",
        "responseHeaders": {},
        "responseTime": 310,
        "attemptedAt": "<string>"
      }
    ]
  }
}

{
  "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": 404,
  "error": "Not Found",
  "message": "Resource not found",
  "code": "NOT_FOUND"
}

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

Path Parameters

deliveryId

string

required

Webhook delivery ID

Response

Complete webhook event and delivery diagnostics

success

boolean

Example:

true

data

object

Show child attributes

⌘I

Inspect a webhook event and all delivery attempts

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

import requests

url = "https://api.hyperprop.com/platform/v1/organization/webhook-deliveries/{deliveryId}"

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/webhook-deliveries/{deliveryId}', 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/webhook-deliveries/{deliveryId}",
  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/webhook-deliveries/{deliveryId}"

	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/webhook-deliveries/{deliveryId}")

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": {
    "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>",
    "payload": {},
    "attempts": [
      {
        "id": "<string>",
        "attempt": 2,
        "status": "delivered",
        "httpStatus": 500,
        "responseBody": "Internal Server Error",
        "responseHeaders": {},
        "responseTime": 310,
        "attemptedAt": "<string>"
      }
    ]
  }
}

{
  "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": 404,
  "error": "Not Found",
  "message": "Resource not found",
  "code": "NOT_FOUND"
}

{
  "success": false,
  "statusCode": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Inspect a webhook event and all delivery attempts

Authorizations

Path Parameters

Response