PostalPortal/PostalPoint_Plugins
PostalPortal/PostalPoint_Plugins
2
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

Update events list

Browse Source
This commit is contained in:
Skylar Ittner 2026-01-14 22:51:45 -07:00
parent bc98bc9e1d
commit 718b24e6be
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/Events.md
View File

@ -11,6 +11,8 @@ Plugins can use `global.apis.eventbus` to receive events when certain actions ha
* `transactionFinished`: Contains a receipt object of a transaction that was just finalized. * `transactionFinished`: Contains a receipt object of a transaction that was just finalized.
* `receiveFromCustomerScreen`: Contains the event sent from the customer-facing display's custom HTML interface via `window.parent.postMessage` * `receiveFromCustomerScreen`: Contains the event sent from the customer-facing display's custom HTML interface via `window.parent.postMessage`
* `customerSignatureCollected`: Contains a signature image from the customer-facing display, in the structure `{"svg": "data:image/svg+xml;base64,...", "png": "data:image/png;base64,..."}`. * `customerSignatureCollected`: Contains a signature image from the customer-facing display, in the structure `{"svg": "data:image/svg+xml;base64,...", "png": "data:image/png;base64,..."}`.
* `settingsSaved`: Emitted when PostalPoint's settings are saved. Usually this means the user changed a setting in the UI.
* `pluginSettingsSaved`: Emitted when the user saves a plugin's settings. The plugin ID is sent as the event data.
## Example Code ## Example Code