Skip to Content

job.succeeded

A job finished and its outputs are on the product. data: The job as it finished, as in GET /api/v1/jobs/{jobId}, outputs included.

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/job.succeeded
Request Body
application/json
{  "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  }}
Header Parameters
{  "CharpstAR-Event": "job.succeeded",  "CharpstAR-Delivery": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "CharpstAR-Signature": "string",  "User-Agent": "CharpstAR-Webhooks/1"}