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

PartnerWebhookTestRequest. Names one of your endpoints to ping.

id
string
required

The webhook id to ping.

Response

The delivery attempt’s outcome, success or failure (PartnerWebhookTestResponse)

PartnerWebhookTestResponse. The report of one live delivery attempt. A refusing endpoint is a 200 here with ok: false — the call did its job by dialing, and telling you it failed is the answer you asked for.

ok
boolean
required

True when your endpoint answered 2xx.

status
integer | null
required

The HTTP status your endpoint returned, or null when the dial never completed.

detail
string | null
required

Why it failed (a timeout, a refused host, a non-2xx), or null on success.