POST /api/v1/webhooks.| Field | Value |
|---|---|
eventType | A specific event type, such as Order or Fine. |
callbackAuth.type | Persistent |
POST /api/v1/webhooks{
"eventType": "Order",
"callbackAuth": {
"type": "Persistent"
}
}200 OK:{
"subscriptionId": "5f7a79b6-5698-460f-9384-f1abea4e8390"
}status property.| Parameter | Required | Description |
|---|---|---|
eventType | Yes | The subscribed event type, for example Order. |
status | No | Status of the document (e.g. Ready ). |
nextToken | No | Continuation token from a previous page of results. |
GET /api/v1/transactions-feed?eventType=Order&status=Ready{
"items": [
{
"transactionId": "8dfc76b7-218b-4d5a-aed6-a73f6c680d20",
"documentId": "ec85ca8c-e42a-4752-9fd5-e050b8e19115",
"eventType": "Order",
"event": "order.process.success",
"status": "Ready",
"createdAt": "2026-07-14T10:00:00Z"
}
],
"nextToken": "nextTokenExample"
}documentId to fetch the full document details for that eventType.nextToken, call the same endpoint again with that token inside nextToken parameter until every page is read. Keep eventType and status=Ready the same while paging.PUT /api/v1/transactions-feed/{transactionId}transactionId from the feed item. The request has no body.204 No Content and moves the item from Ready to Completed.Acknowledge only after successful processing. Acknowledging an unknown or already completed transaction returns 404 Not Found.
createdAt property.| Parameter | Required | Description |
|---|---|---|
eventType | Yes | The subscribed event type, for example Order. |
dateFrom | No | UTC timestamp (YYYY-MM-DDTHH:MM:SS). Returns items with createdAt at or after this time. Cannot be in the future. |
nextToken | No | Continuation token from a previous page of results. |
GET /api/v1/transactions-feed?eventType=Order&dateFrom=2026-07-14T09:30:00ZOrder created at 2026-07-13T09:29:59Z is not returned (before dateFrom).Order created at 2026-07-14T10:00:00Z is returned.documentId from each feed item to retrieve the full document from the endpoint based from eventType .createdAt and pass it as dateFrom.nextToken is present from the query, to get next page, pass it to nextToken parameter with the same eventType and dateFrom.