Skip to main content
POST
Send a test event

Authorizations

Authorization
string
header
required

Short-lived JWT issued by the CarHub auth service (Better Auth), verified against its JWKS. Claims: sub (user), org_id (active organisation) and role (owner | admin | member). Used by the dashboard for /mgmt/v1/… only — it is never accepted on /v1/….

Path Parameters

id
string
required

Webhook endpoint identifier.

Pattern: ^whe_[1-9A-HJ-NP-Za-km-z]{8,32}$

Body

application/json
event_type
enum<string>

Event to simulate. Defaults to job.succeeded.

Available options:
job.succeeded,
job.failed,
inspection.stage_completed
endpoint
enum<string>

Whose sandbox fixture to build the payload from. Defaults to plate.read.

Available options:
vehicle.analyse,
vehicle.segment,
vehicle.identify,
vin.read,
plate.read,
document.read,
dashboard.read,
engine.detect,
video.onboard,
damage.detect,
damage.severity,
tire.read,
tire.detect,
parts.recognize,
parts.segment,
parts.decompose,
pricing.vehicle,
pricing.repair,
render.background,
render.enhance,
render.plate,
render.360,
render.video,
viewer.hotspots,
inspections

Response

Delivery attempted; the outcome is in the body.

delivery_id
string
required
Example:

"whd_3PqL7sVx"

delivered
boolean
required

True when your endpoint answered 2xx.

status_code
integer | null
required
duration_ms
integer
required
Required range: x >= 0
event
Event · object
required

The exact payload that was sent, signature included in the headers.

error
string | null
required

Transport or timeout error, when the delivery never reached a status code.