automation.webhook

POST

Sent by an automation’s webhook step to the endpoint the step names, whatever event types that endpoint takes, and retried and logged as its other deliveries are. Its payload is the JSON the step wrote. No event: it is not a type an endpoint subscribes to, and it never appears in GET /v1/events.

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

required

object

id

required

The automation’s id.

string

name

required

What the automation was called when it acted.

string

createdAt

required

When the step ran, in milliseconds since the Unix epoch.

integer

id

required

awh_…, the same for every attempt of the same firing’s step, so a receiver can drop one it has already handled.

string

payload

The JSON the automation’s webhook step wrote, its placeholders filled in.

type

required

string

Allowed values: automation.webhook

via

required

string

Examples

Exampleexample

Example

{
  "automation": {
    "id": "aut_6b2e9f41-3c7d-4a58-9e10-2d4b8c7a5f13",
    "name": "Tell the warehouse"
  },
  "createdAt": 1790000000000,
  "id": "awh_4f1c9a7e2b6d8035c1e9a4f7",
  "payload": {
    "order": "ord_8c3f1a9e2d7b",
    "status": "failed"
  },
  "type": "automation.webhook",
  "via": "automation"
}

Responses

200

Any 2xx acknowledges the delivery.