Print settings

Print settings webhooks are emitted by the Accounts API when print settings are updated (PUT /print-settings).

Events

Action Event name
update print settings (PUT /print-settings) printsettings.updated

Payload example (printsettings.updated)

{
  "attemptId": "e7fd1e89-7aec-4bf1-8087-49f6b91d99bc",
  "created": 1629394741,
  "data": {
    "backoffice": {
      "autoPrint": false,
      "custom": false,
      "customPrinterModel": ""
    },
    "pdfParcel": {
      "hidePrices": false,
      "shippingTotals": false,
      "transactionTotals": true
    },
    "pdfTicket": {
      "hidePrices": false,
      "ticketFields": {
        "footer": {
          "content": "",
          "label": "Ticket footer",
          "order": 0
        }
      },
      "tripName": true,
      "useTicketFieldsForProviderProducts": false
    },
    "pdfTransaction": {
      "receiptFields": {
        "footer": {
          "content": "",
          "label": "Receipt footer",
          "order": 1
        },
        "header": {
          "content": "",
          "label": "Receipt header",
          "order": 0
        }
      },
      "useReceiptFieldsForProviderProducts": false
    },
    "productTemplates": []
  },
  "event": "printsettings.updated",
  "id": "9f34e653-779c-4b6b-bbd4-2d84bdcb6cae",
  "livemode": true
}

The API emits the event with { providerId, apiKey, data: printSettings }. The webhook envelope may expose these as data.providerId, data.apiKey, and data (or data.data) containing the print settings object above.

Payload fields (printsettings.updated)

Field Type Description
id string Webhook event id
attemptId string Delivery attempt id
created number Unix timestamp when the event was created
event string printsettings.updated
livemode boolean Whether the account is in live mode
data object Print settings or envelope (providerId, apiKey, data)
data.backoffice object autoPrint, custom, customPrinterModel
data.pdfTicket object tripName, hidePrices, ticketFields, useTicketFieldsForProviderProducts, limitRePrint
data.pdfParcel object hidePrices, shippingTotals, transactionTotals
data.pdfTransaction object receiptFields, useReceiptFieldsForProviderProducts
data.productTemplates array Product templates (when present)