Skip to main content
POST
Send a test event to a registration

Authorizations

Authorization
string
header
required

Per-client API key (M2M). Presented as Authorization: Bearer <key>.

Headers

X-Brand-Id
string
required

Your brand id (brd_...). It must be one of the brands your API key's account owns; with a publishable key it must be the one brand the key was issued for. A missing or malformed value is refused with 400, and an unknown or foreign brand with 404.

Pattern: ^brd_[A-Za-z0-9][A-Za-z0-9_-]*$
X-Correlation-Id
string

An optional id you send to tie this request to your own logs. Send one and it is echoed back unchanged; omit it and one is assigned for you. Either way the id is returned in the X-Correlation-Id response header on every response, including errors, so you can match a response to the request that produced it.

Maximum string length: 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$

Path Parameters

registration_id
string
required
Pattern: ^whr_[A-Za-z0-9][A-Za-z0-9_-]*$

Body

application/json
event_type
enum<string>

must be one of the registration's subscribed types; defaults to the first

Available options:
journey.prospect.captured.v1,
journey.intake.submitted.v1,
journey.eligibility.evaluated.v1,
journey.evaluation.deferred.v1,
journey.evaluation.resumed.v1,
journey.identity.bound.v1,
journey.case.opened.v1,
journey.payment.succeeded.v1,
journey.identity.verified.v1,
journey.visit.completed.v1,
journey.labs.skipped.v1,
journey.rx.transmitted.v1,
journey.shipment.shipped.v1,
journey.shipment.delivered.v1,
journey.checkin.completed.v1,
journey.step.abandoned.v1,
onboarding.client.started.v1,
onboarding.step.started.v1,
onboarding.step.assigned.v1,
onboarding.step.completed.v1,
onboarding.step.nudged.v1,
onboarding.step.escalated.v1,
onboarding.agreement.executed.v1,
onboarding.completion.gate_ready.v1,
onboarding.completion.e2e_result.v1,
onboarding.client.completed.v1

Response

the observed single-shot outcome

data
object
required

The observed single-shot outcome — the REAL POST result: on the hosted platform the delivery actually leaves the platform, and delivered: true is never synthesized. A failed attempt names what didn't run in detail instead of a bare false.