Interface: TestOrgWebhookEndpointRequest
Defined in: packages/sdk/src/types/generated/organization_webhook.ts:190
Send one payload to an endpoint, now, outside the delivery queue.
eventType picks which sample the server builds when payload is
omitted, and it stays in the closed subscribable vocabulary for the same
reason the subscription list does. It is deliberately NOT required to be
one of the endpoint's subscribed types: an operator wiring up a new
receiver wants to exercise a type before subscribing to it, and a test
send writes nothing to the queue that a subscription would govern.
payload is the operator's own edit of that sample — the whole point of
the feature is that they can put their own identifiers in it and watch
their handler run. It is sent as given (canonicalized and signed like any
delivery), not merged into a server-built envelope: a merge would mean an
operator could not test what happens when a field is absent.
So the two can disagree, and that is allowed. When payload is
supplied, the body's event_type is whatever the operator wrote — this
request's eventType no longer describes what the receiver will see.
Reconciling them would defeat the feature: "what does my handler do when
the body says one thing and the header another" is a case worth being able
to exercise. eventType remains the value the audit trail records
alongside bodySource, which says whether the body was ours or theirs,
so a reader of the audit log is never misled about which one it describes.
Properties
eventType
eventType:
string
Defined in: packages/sdk/src/types/generated/organization_webhook.ts:191
payload?
optionalpayload:TestOrgWebhookEndpointRequestPayload
Defined in: packages/sdk/src/types/generated/organization_webhook.ts:192