Skip to main content

Interface: OrgWebhookSamplePayloadResponse

Defined in: packages/sdk/src/types/generated/organization_webhook.ts:157

A representative delivery body for one event type.

What the org UI prefills its test-send editor with, and what the public event catalog is generated from — one builder (lib.activity.samples.sample_event), so the payload an operator edits and the payload the docs describe cannot diverge.

The body is a real, validated envelope wrapped by the same build_delivery_payload a queued delivery goes through, so it carries the endpoint block and the endpoint's own org_uuid exactly as a live delivery would. Every uuid in it is synthetic: the sample names no row in any database.

Properties

eventType

eventType: string

Defined in: packages/sdk/src/types/generated/organization_webhook.ts:158


family

family: string

Defined in: packages/sdk/src/types/generated/organization_webhook.ts:159


payload

payload: OrgWebhookSamplePayloadResponsePayload

Defined in: packages/sdk/src/types/generated/organization_webhook.ts:160