Skip to Content

Event types

Every event we send, when we send it, what its data holds, and an example of each.

Every event has the same envelope:

{
  "id": "7d2e4f61-8a9b-4c0d-9e1f-2a3b4c5d6e7f",
  "type": "status.changed",
  "occurredAt": "2026-10-20T09:31:00.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": "CH-1001",
  "data": {
    "from": "in_production",
    "to": "in_review"
  }
}
  • article is the article number the event is about. id is the delivery id, also sent as the CharpstAR-Delivery header.
  • Events are a fast signal. When in doubt, read the asset again with GET /api/v1/assets/{article}: that is always current.
EventSent when
product.receivedA new product is in our intake, whether you sent it or your CharpstAR team added it.
status.changedA product's status changes, for example from in_production to in_review, or from approved to delivered. Internal steps that keep the same status send nothing.
review.requestedA model has passed our quality check and waits for your approval.
asset.approvedA 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.
asset.images.updatedImages were added, replaced or removed for a product. Changes made close together arrive as one event, about a minute later.
job.succeededA job finished and its outputs are on the product.
job.failedA job could not finish.
job.cancelledA job was cancelled: by you while it was queued, or stopped by our team.
pingYou asked for a test with POST /api/v1/webhooks/{webhook_id}/test. Every subscription gets it; you cannot subscribe to it.

An example of every event

product.received

{
  "id": "3c9e1f20-7b6a-4d5c-8e9f-0a1b2c3d4e5f",
  "type": "product.received",
  "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",
    "category": "Furniture",
    "subcategory": "Chairs",
    "dimensionsCm": {
      "w": 72,
      "h": 81,
      "d": 78
    },
    "productLink": "https://example.com/products/oslo-lounge-chair",
    "status": "received",
    "receivedAt": "2026-10-20T09:30:58.000Z"
  }
}

status.changed

{
  "id": "7d2e4f61-8a9b-4c0d-9e1f-2a3b4c5d6e7f",
  "type": "status.changed",
  "occurredAt": "2026-10-20T09:31:00.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": "CH-1001",
  "data": {
    "from": "in_production",
    "to": "in_review"
  }
}

review.requested

{
  "id": "5e6f7a8b-9c0d-4e1f-8a2b-3c4d5e6f7a8b",
  "type": "review.requested",
  "occurredAt": "2026-10-20T09:31:00.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": "CH-1001",
  "data": {
    "articleId": "CH-1001",
    "reviewUrl": "https://platform.charpstar.co/client-review/3f2a1b0c-4d5e-4f6a-8b7c-9d0e1f2a3b4c"
  }
}

asset.approved

{
  "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
      }
    ]
  }
}

asset.images.updated

{
  "id": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
  "type": "asset.images.updated",
  "occurredAt": "2026-10-20T09:31:00.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": "CH-1001",
  "data": {
    "added": [
      "8d2f4c1a-packshot"
    ],
    "removed": []
  }
}

job.succeeded

{
  "id": "2f3e4d5c-6b7a-4c8d-9e0f-1a2b3c4d5e6f",
  "type": "job.succeeded",
  "occurredAt": "2026-11-02T08:09:52.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": "CH-1001",
  "data": {
    "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
    "type": "packshot",
    "articleId": "CH-1001",
    "variant": null,
    "status": "succeeded",
    "options": {
      "views": [
        "front",
        "left",
        "back"
      ],
      "background": "transparent",
      "size": 4096,
      "aspectRatio": "1:1",
      "format": "png",
      "shadows": true,
      "lighting": "studio",
      "preset": "Marketplace (GS1)"
    },
    "naming": {
      "preset": "gs1"
    },
    "metadata": {
      "purchaseOrder": "PO-88213"
    },
    "createdAt": "2026-11-02T08:00:00.000Z",
    "startedAt": "2026-11-02T08:01:10.000Z",
    "finishedAt": "2026-11-02T08:09:52.000Z",
    "outputs": [
      {
        "id": "c41f9a07-2b3c-4d5e-8f6a-7b8c9d0e1f2a",
        "type": "packshot",
        "view": "front",
        "format": "png",
        "fileName": "09521234567806_C1C0.png",
        "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C1C0.png",
        "width": 4096,
        "height": 4096,
        "bytes": 3210442
      },
      {
        "id": "5e83d1b2-3c4d-4e5f-9a6b-8c9d0e1f2a3b",
        "type": "packshot",
        "view": "left",
        "format": "png",
        "fileName": "09521234567806_C2C0.png",
        "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C2C0.png",
        "width": 4096,
        "height": 4096,
        "bytes": 3210442
      },
      {
        "id": "f0a7c6e9-4d5e-4f6a-8b7c-9d0e1f2a3b4c",
        "type": "packshot",
        "view": "back",
        "format": "png",
        "fileName": "09521234567806_C7C0.png",
        "url": "https://renders.charpstar.net/YourCompany/5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045/7e1d0c2b-0000-4000-8000-000000000001/09521234567806_C7C0.png",
        "width": 4096,
        "height": 4096,
        "bytes": 3210442
      }
    ],
    "error": null
  }
}

job.failed

{
  "id": "3a4b5c6d-7e8f-4a9b-8c0d-1e2f3a4b5c6d",
  "type": "job.failed",
  "occurredAt": "2026-11-02T08:09:52.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": "CH-1001",
  "data": {
    "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
    "type": "packshot",
    "articleId": "CH-1001",
    "variant": null,
    "status": "failed",
    "options": {
      "views": [
        "front",
        "left",
        "back"
      ],
      "background": "transparent",
      "size": 4096,
      "aspectRatio": "1:1",
      "format": "png",
      "shadows": true,
      "lighting": "studio",
      "preset": "Marketplace (GS1)"
    },
    "naming": {
      "preset": "gs1"
    },
    "metadata": {
      "purchaseOrder": "PO-88213"
    },
    "createdAt": "2026-11-02T08:00:00.000Z",
    "startedAt": "2026-11-02T08:01:10.000Z",
    "finishedAt": "2026-11-02T08:09:52.000Z",
    "outputs": [],
    "error": {
      "code": "internal_error",
      "message": "The pictures could not be made. Our team has been told; you can start the job again."
    }
  }
}

job.cancelled

{
  "id": "4b5c6d7e-8f9a-4b0c-9d1e-2f3a4b5c6d7e",
  "type": "job.cancelled",
  "occurredAt": "2026-11-02T08:09:52.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": "CH-1001",
  "data": {
    "id": "5c0e2f9a-7b14-4d3e-a8c1-93f6e2b7d045",
    "type": "packshot",
    "articleId": "CH-1001",
    "variant": null,
    "status": "cancelled",
    "options": {
      "views": [
        "front",
        "left",
        "back"
      ],
      "background": "transparent",
      "size": 4096,
      "aspectRatio": "1:1",
      "format": "png",
      "shadows": true,
      "lighting": "studio",
      "preset": "Marketplace (GS1)"
    },
    "naming": {
      "preset": "gs1"
    },
    "metadata": {
      "purchaseOrder": "PO-88213"
    },
    "createdAt": "2026-11-02T08:00:00.000Z",
    "startedAt": null,
    "finishedAt": "2026-11-02T08:00:20.000Z",
    "outputs": [],
    "error": null
  }
}

ping

{
  "id": "1b2c3d4e-5f6a-4b7c-8d9e-0f1a2b3c4d5e",
  "type": "ping",
  "occurredAt": "2026-10-20T09:31:00.000Z",
  "client": {
    "id": "e2b7c1d4-5a6f-4b8c-9d0e-1f2a3b4c5d6e",
    "name": "Your Company"
  },
  "article": null,
  "data": {
    "message": "Test notification from CharpstAR."
  }
}

On this page