Skip to main content
POST
/
stocks
/
api
/
webhooks
/
register
curl -X POST "https://api.trusset.org/stocks/api/webhooks/register" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: trusset_abc123xy_secret..." \
  -d '{
    "name": "Settlement System",
    "webhookUrl": "https://api.example.com/webhooks/trusset"
  }'
{
  "success": true,
  "data": {
    "id": "wh_abc123",
    "name": "Settlement System",
    "apiKey": "whk_live_...",
    "webhookSecret": "whs_live_...",
    "webhookUrl": "https://api.example.com/webhooks/trusset"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-06-15T12:00:00.000Z",
    "instanceId": "inst_abc123"
  }
}
Registers a new webhook partner for the authenticated instance. Returns an API key and webhook secret used to authenticate incoming webhook deliveries. The webhook URL must use HTTPS.

Request Body

name
string
required
Display name for this webhook integration. Maximum 100 characters.
webhookUrl
string
required
HTTPS URL where events will be delivered.

Response Fields

success
boolean
Request status.
data
object
The apiKey and webhookSecret are only returned once at registration time. Store them securely.
curl -X POST "https://api.trusset.org/stocks/api/webhooks/register" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: trusset_abc123xy_secret..." \
  -d '{
    "name": "Settlement System",
    "webhookUrl": "https://api.example.com/webhooks/trusset"
  }'
{
  "success": true,
  "data": {
    "id": "wh_abc123",
    "name": "Settlement System",
    "apiKey": "whk_live_...",
    "webhookSecret": "whs_live_...",
    "webhookUrl": "https://api.example.com/webhooks/trusset"
  },
  "metadata": {
    "requestId": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2025-06-15T12:00:00.000Z",
    "instanceId": "inst_abc123"
  }
}