Skip to main content
POST
TypeScript

Authorizations

Authorization
string
header
required

A partner-scoped API key (trdrs_sk_…), issued to a trdrs Connect partner firm and accepted only under /api/partner/. Same format as the firm (tenant) key, different scope: a firm API key is refused here, and this key is refused everywhere else.

Body

application/json

PartnerWebhookCreateRequest. Register one endpoint. Omit events to receive everything; five endpoints per firm.

url
string
required

An https:// URL (≤500 chars). Plain http is refused, and a host resolving to a private address is refused at delivery time.

events
enum<string>[]

Optional filter. Omitted or empty = every event type, including ones added later.

Available options:
registration.linked,
registration.revoked,
account.reset,
balance.recorded,
risk.locked,
risk.unlocked

Response

The registered endpoint, including its signing secret (PartnerWebhookResponse)

webhook
object
required

PartnerWebhook. One registered endpoint. secret is returned on every read on purpose: it authenticates us to your endpoint and grants nothing here, and the only reader is your own partner key.

Example: