export.succeeded | SpreadSpace

Fires once when an export’s bundle is ready to download. Fetch the export to get a fresh download link; the event never carries one.

Headers

Payload

The payload of this webhook request is an object.

idstringRequiredformat: "^evt_[0-9a-f]{24}$"

Event id: evt_ plus 24 lowercase hex characters. Also sent as the SpreadSpace-Event-Id header. Stable across retries and replays, so dedupe on it.

typeenumRequired

Always this event type on this body.

createdlongRequired

Seconds since the Unix epoch at which the event was created server-side. Seconds, not milliseconds. Deliveries are not ordered; reconcile on this.

tenant_idstringRequired

The workspace the event belongs to. Reject a delivery whose tenant does not match the endpoint you registered.

livemodebooleanRequired

true for live activity, false for test mode (an ss_test_ key or the sandbox simulator). Branch on it to route test deliveries to a staging handler.

dataobjectRequired

The data object on an export.succeeded delivery. The bundle is built and ready to pull. No link travels in the event: fetch the export through the API and use the download link it mints for that read.

Response

2XX

Return any 2xx within 5 seconds. A 4xx other than 429 stops retries for that delivery. 429, 5xx, network errors and timeouts are retried, 12 times over 24 hours.

Signature over the exact request body: t=<seconds since the Unix epoch>,v1=<lowercase hex HMAC-SHA256 of "{t}.{body}" keyed with your endpoint's signing secret>. Verify it before trusting the body, and reject a t more than five minutes from your own clock. During a secret rotation both the new and the previous secret verify for 24 hours; each delivery is signed with exactly one.

The event id, identical to the body’s id. Stable across retries and replays, and shared by every endpoint one event fans out to. Delivery is at-least-once, so dedupe on it.