Skip to Content

asset.approved

A model is approved. We hold the event until the files are live (up to 30 minutes), so it usually arrives with status delivered and every link filled in. This is the one to act on. data: The full asset, as in GET /api/v1/assets/{article}. If the files were not live in time, only articleId and status approved; status.changed follows once it is delivered.

Header Parameters

CharpstAR-Event*string
CharpstAR-Delivery*string

The delivery id; the same on every retry.

Formatuuid
CharpstAR-Signature*string

t=,v1=<hex HMAC SHA-256 of t + '.' + raw body, keyed with your whsec_ secret>

User-Agent*string

Request Body

application/json
  1. body
id*string

The delivery id; the same as the CharpstAR-Delivery header and the same on every retry.

Formatuuid
type*string
occurredAt*string

When it happened on our side.

Formatdate-time
client*

The company the key belongs to.

article*|

The article number the event is about, or null when the event is not about one product.

data*|

Response Body

Any 2xx within 10 seconds means handled. Anything else is retried.

Example Requests
POST/asset.approved
Request Body
application/json
{  "id": "6f1c2b9e-1d2c-4f7a-9a3b-5c6d7e8f9a0b",  "type": "asset.approved",  "occurredAt": "2026-10-20T09:31:00.000Z",  "client": {    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",    "name": "Your Company"  },  "article": "CH-1001",  "data": {    "articleId": "CH-1001",    "name": "Oslo lounge chair",    "status": "delivered",    "deliveryDate": "2026-10-20",    "updatedAt": "2026-10-20T09:30:00.000Z",    "glbUrl": "https://cdn.charpstar.net/YourCompany/Android/CH-1001.glb",    "usdzUrl": "https://cdn.charpstar.net/YourCompany/iOS/CH-1001.usdz",    "usdzReady": true,    "thumbnailUrl": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",    "viewerUrl": "https://platform.charpstar.co/agent-viewer?glb=https%3A%2F%2Fcdn.charpstar.net%2FYourCompany%2FAndroid%2FCH-1001.glb&name=Oslo%20lounge%20chair&viewer=default",    "arUrl": "https://platform.charpstar.co/ar/0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",    "embed": {      "dataClient": "YourCompany",      "dataArticleId": "CH-1001",      "snippet": "<script src=\"https://js.charpstar.net/V2/charpstAR-Base.js\" data-client=\"YourCompany\" data-language=\"en-gb\" defer></script>\n<charpstar-viewer data-articleid=\"CH-1001\"></charpstar-viewer>"    },    "images": [      {        "id": "8d2f4c1a-packshot",        "type": "packshot",        "variant": "Oak",        "url": "https://cdn.charpstar.net/YourCompany/Packshots/CH-1001-front.png",        "fileName": "CH-1001_packshot_front_1.png",        "width": 2048,        "height": 2048,        "bytes": 412331,        "createdAt": "2026-10-20T09:00:00.000Z",        "approved": true,        "primary": true,        "jobId": null      },      {        "id": "thumbnail:0b6c9f0e-5d1a-4c47-9f4e-2a1d3c4b5e6f",        "type": "thumbnail",        "variant": null,        "url": "https://cdn.charpstar.net/YourCompany/Thumbnails/CH-1001.png",        "fileName": "CH-1001_thumbnail_1.png",        "width": null,        "height": null,        "bytes": 88120,        "createdAt": "2026-10-20T08:55:00.000Z",        "approved": true,        "primary": false,        "jobId": null      }    ],    "variations": [      {        "articleId": "CH-1001-B",        "status": "in_production",        "thumbnailUrl": null,        "glbUrl": null      }    ]  }}
Header Parameters
{  "CharpstAR-Event": "asset.approved",  "CharpstAR-Delivery": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "CharpstAR-Signature": "string",  "User-Agent": "CharpstAR-Webhooks/1"}