Open Collections

Setup

Configure the URL we'll deliver payments to.

Requirements

  • Open Collections enabled on your account (contact sales)
  • A publicly reachable HTTPS endpoint
  • A secret API key (hpn_live_sk_*) with the webhooks:manage scope, or a dashboard session

Dashboard

Settings → Open Collections. Paste your HTTPS URL, save, copy the secret. It’s shown once.

API

Bash 
POST /v1/open-collections/endpoint
Authorization: Bearer hpn_live_sk_xxxxxxxxxxxxx
Content-Type: application/json

{
  "url": "https://your-server.com/harpoon/payments",
  "description": "Wallet credit listener"
}
JSON 
{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "url": "https://your-server.com/harpoon/payments",
    "description": "Wallet credit listener",
    "is_active": true,
    "is_sandbox": false,
    "last_success_at": null,
    "last_failure_at": null,
    "consecutive_failures": 0,
    "created_at": "2026-04-29T12:00:00Z",
    "updated_at": "2026-04-29T12:00:00Z"
  },
  "secret": "whsec_xxxxxxxxxxxxxxxxxxxxx"
}

The secret is only returned at creation. Reveal it later from the dashboard with your password.

Test the endpoint

Bash 
POST /v1/open-collections/endpoint/test
Authorization: Bearer hpn_live_sk_xxxxxxxxxxxxx
JSON 
{
  "success": true,
  "status_code": 200,
  "response_body": "{"received": true}",
  "message": "Endpoint accepted the test delivery."
}

The test uses the same delivery path and signature as a real event, with synthetic data and a "test": true flag in the payload.

Next
Payload reference →
Also useful
Manage your endpoint →