order.released

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

externalRef

string | null

>= 1 characters <= 256 characters

orderId

required

string

printId

required

string

printIds

Array<string>

releasedBy

required

string

status

required

string

type

required

string

Allowed values: order.released

via

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

string

Allowed values: automation

Examples

Exampleexample

Example

{
  "createdAt": 1790001300000,
  "id": "1790001300000-5e7f9a1b-3c4d-4e6f-8a0b-2c4d6e8f0a1b",
  "payload": {
    "externalRef": "shop-order-1042",
    "orderId": "e1f2a3b4-c5d6-4e7f-8a9b-0c1d2e3f4a5b",
    "printId": "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f",
    "printIds": [
      "c4d5e6f7-a8b9-4c0d-9e1f-2a3b4c5d6e7f"
    ],
    "releasedBy": "month_reset",
    "status": "awaiting_prints"
  },
  "type": "order.released"
}

Responses

200

Any 2xx acknowledges the delivery.