Skip to main content
GET
/
v1
/
partner
/
webhooks
List registered webhooks
curl --request GET \
  --url https://api.hypermid.io/v1/partner/webhooks \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "webhooks": [
      {
        "id": "whk_abc123def456",
        "url": "https://yourapp.com/webhooks/hypermid",
        "events": ["swap.completed", "swap.failed", "onramp.completed"],
        "active": true,
        "createdAt": "2024-03-25T10:30:00Z",
        "lastDeliveredAt": "2024-03-25T14:22:00Z"
      },
      {
        "id": "whk_xyz789ghi012",
        "url": "https://staging.yourapp.com/webhooks/hypermid",
        "events": ["swap.completed"],
        "active": true,
        "createdAt": "2024-02-10T08:00:00Z",
        "lastDeliveredAt": null
      }
    ]
  },
  "error": null,
  "meta": {
    "requestId": "a7d8e9f0-a1b2-3456-0123-567890123456",
    "timestamp": 1711234585,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1973,
      "reset": 1711234627
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hypermid.io/llms.txt

Use this file to discover all available pages before exploring further.

Returns all webhook endpoints registered for your partner account. 
{
  "data": {
    "webhooks": [
      {
        "id": "whk_abc123def456",
        "url": "https://yourapp.com/webhooks/hypermid",
        "events": ["swap.completed", "swap.failed", "onramp.completed"],
        "active": true,
        "createdAt": "2024-03-25T10:30:00Z",
        "lastDeliveredAt": "2024-03-25T14:22:00Z"
      },
      {
        "id": "whk_xyz789ghi012",
        "url": "https://staging.yourapp.com/webhooks/hypermid",
        "events": ["swap.completed"],
        "active": true,
        "createdAt": "2024-02-10T08:00:00Z",
        "lastDeliveredAt": null
      }
    ]
  },
  "error": null,
  "meta": {
    "requestId": "a7d8e9f0-a1b2-3456-0123-567890123456",
    "timestamp": 1711234585,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1973,
      "reset": 1711234627
    }
  }
}

const webhooks = await client.listWebhooks();

for (const wh of webhooks.data.webhooks) {
  console.log(`${wh.id}: ${wh.url} (${wh.active ? "active" : "inactive"})`);
  console.log(`  Events: ${wh.events.join(", ")}`);
}

Authorizations

​
X-API-Key
string
header
required

Partner API key. Optional for public endpoints, required for /v1/partner/*.

Response

Webhook list

​
data
object
required

Response payload (null on error)

​
error
object
required
​
meta
object
required