wrapper.ready

Wrapper finished building

This event is in the contract, but Vojo does not send it yet. You cannot subscribe to it until it ships.

Will be sent when a wrapper that POST /v1/wrappers accepted with 202 finishes building. data is the v1 Wrapper resource with status ready, the same as GET /v1/wrappers/{wrapper_id}. It won't be sent for wrappers returned ready with 201. Wrapping is synchronous today, so you always get 201.

Delivery headers

POST /your/endpoint HTTP/1.1
Content-Type: application/json
X-Vojo-Signature: t=1761037200,v1=5257a869e7ecebeda32affa62cdca3fa51cad7e77a0e56ff536d0ce8e108d8bd

Example payload

{
  "event_type": "wrapper.ready",
  "event_id": "evt_wrapper_01",
  "attempt_id": "att_7Hq4",
  "organisation_id": "org_123",
  "api_version": "2026-10-07",
  "created_at": "2026-10-07T09:30:05Z",
  "data": {
    "id": "wrp_123",
    "status": "ready",
    "failure": null,
    "delivery_mode": "archive",
    "url": "https://cdn.vojo-media.com/wrappers/wrp_123.zip",
    "html": null,
    "fingerprint_id": "fpr_123",
    "fingerprint": "3715283715",
    "metadata": {
      "line_item": "LI-2291"
    },
    "created_at": "2026-10-07T09:30:00Z"
  }
}

Payload

Envelope for wrapper.ready and wrapper.failed. data follows the Wrapper resource.

event_typestringRequired
One of wrapper.ready, wrapper.failed
event_idstringRequired
Stable per-event id, constant across retries. Dedupe on this.
organisation_idstringRequired
api_versionstringRequired
The Vojo-Version the payload is rendered in (the org's pin).
created_atstringRequired
date-time
dataobjectRequired
The v1 Wrapper resource.
attempt_idstring
Per-attempt id; changes on each retry. Do not dedupe on this.

Handling this event

Verify the signature, reply with a 2xx within 20 seconds, then process the event in the background. Retries reuse the same event id, so deduplicate on it.