design.approved

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

approvedVia

required

Any of:

string

string

string

Only on an event recorded before automations were removed: the design was approved when it was committed. No new event has it.

string

consent

How the customer agreed, as the design read’s approvalConsent keeps it: null when none was given. Absent only on an event recorded before approvals carried it.

object

at

required

When the customer agreed, epoch milliseconds.

integer

kind

required

How the customer agreed: by adding the design to their cart, by ticking a box, on a proof page, by approving it again on your store after correcting it (edit), or by letting your store’s own approval deadline pass (deadline). More kinds may be added.

string

ref

required

string | null

designId

required

string

revision

The design’s revision the decision was made about, as the design read’s revision says it. Absent only on an event recorded before decisions carried it.

integer

type

required

string

Allowed values: design.approved

via

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

string

Allowed values: automation

Examples

A connected store, from connect to delivery: 4. Approve it, with the customer's consent

{
  "createdAt": 1790000060000,
  "id": "1790000060000-5d7e1f2a-3b4c-4d5e-8f60-718293a4b5c6",
  "payload": {
    "approvedVia": "explicit",
    "consent": {
      "at": 1790000050000,
      "kind": "checkbox",
      "ref": "WEB-10482"
    },
    "designId": "6f1c8a2b-3d4e-4f5a-8b6c-7d8e9f0a1b2c",
    "revision": 1
  },
  "type": "design.approved"
}

Design to order: 2. The merchant's server approves it

{
  "createdAt": 1790000060000,
  "id": "1790000060000-5d7e1f2a-3b4c-4d5e-8f60-718293a4b5c6",
  "payload": {
    "approvedVia": "explicit",
    "designId": "6f1c8a2b-3d4e-4f5a-8b6c-7d8e9f0a1b2c"
  },
  "type": "design.approved"
}

Responses

200

Any 2xx acknowledges the delivery.