design.committed

POST

Parameters

Header Parameters

x-pixonaut-timestamp

required

When this attempt was sent, in Unix seconds.

string

When this attempt was sent, in Unix seconds.

x-pixonaut-signature

required

v1= followed by the hex HMAC-SHA256, keyed with the endpoint’s signing secret, of the x-pixonaut-timestamp value, a ., and the raw request body.

string

v1= followed by the hex HMAC-SHA256, keyed with the endpoint’s signing secret, of the x-pixonaut-timestamp value, a ., and the raw request body.

Request Body

Media typeapplication/json

object

automation

The automation that caused the event, beside via.

object

id

required

The automation’s id.

string

name

required

What the automation was called when it acted.

string

createdAt

required

When the event happened, in milliseconds since the Unix epoch.

integer

id

required

The event’s id. A retry or a redelivery carries the same id, so a receiver can drop one it has already handled.

string

payload

required

object

apiKeyId

required

string | null

designId

required

string

origin

Where the design came from: the door it was committed through. A duplicate’s is whoever duplicated it.

object

id

required

The designer link’s id, the key’s id, or the connected store’s site address. Null for studio, and for a key set in the deployment’s configuration rather than made in the workspace.

string | null

kind

required

link: a designer link’s page made it. studio: a member made it, in the studio or through an MCP key. secret_key and publishable_key: committed with one of your keys. store: committed by a connected store, with any key its site was given.

string

shareLinkId

string | null

templateId

required

string

type

required

string

Allowed values: design.committed

via

automation when one of your automations caused the event; absent otherwise.

string

Allowed values: automation

Examples

Design to order: 1. The customer commits a design

{
  "createdAt": 1790000000000,
  "id": "1790000000000-0192f5a4-7c1e-4d3a-9b6e-2f4c8a1d5e70",
  "payload": {
    "apiKeyId": "3b2d9c1e-5a4f-4e7d-8c6b-1a0f9e8d7c6b",
    "designId": "6f1c8a2b-3d4e-4f5a-8b6c-7d8e9f0a1b2c",
    "templateId": "tshirt-basic@2"
  },
  "type": "design.committed"
}

Webhooks

{
  "createdAt": 1790000000000,
  "id": "1790000000000-0192f5a4-7c1e-4d3a-9b6e-2f4c8a1d5e70",
  "payload": {
    "apiKeyId": "3b2d9c1e-5a4f-4e7d-8c6b-1a0f9e8d7c6b",
    "designId": "6f1c8a2b-3d4e-4f5a-8b6c-7d8e9f0a1b2c",
    "templateId": "tshirt-basic@2"
  },
  "type": "design.committed"
}

Responses

200

Any 2xx acknowledges the delivery.