Webhooks Release Notes

Introduction

Development of our Webhooks functionality is currently in progress. Use this page to keep up-to-date with recent changes and added functionality.


Release 18.0.0

Release Date: 2019-09-23
Database Version: 18.0.0
Q-line POS Version: 18.0.0 Download Q-line POS 18.0.0 · Download MSI

+

Webhooks: When dealing with a required requestScanCode, it is now possible to cancel the whole webhook. Previously it was possible to keep the POS in an unending loop, because it kept asking for a code to be scanned.

Also the POS won't lock anymore when cancelling a non-required requestScanCode.

+

It is now possible to configure for every webhook event if cancelling the webhook requires authorization. This can also be used as an additional security measure to prevent a webhook from being cancelled prematurely.

Release 17.2.3

Release Date: 2019-09-09
Database Version: 17.1.0
Q-line POS Version: 17.2.3 Download Q-line POS 17.2.3

+

Webhooks: Added the properties session.lines[].priceExcl, session.lines[].totalExclAmount and session.totalExclAmount.

Release 17.2.0

Release Date: 2019-08-30
Database Version: 17.1.0
Q-line POS Version: 17.2.3 Download Q-line POS 17.2.3

+

Webhooks: The receiptFooter now has a max. length of 10,000 characters (previously 1000).

Release 17.1.1

Release Date: 2019-08-23
Database Version: 17.1.0
Q-line POS Version: 17.2.3 Download Q-line POS 17.2.3

Webhooks: Solved an issue where the Webhook-popup would appear later than configured.

Webhooks: Solved a bug that would occur when trying to delete a text line while the removeSessionLine webhook was activated.

Webhooks: It is now possible to combine dialog and customerMessage in one response.

Release 17.1.0

Release Date: 2019-08-15
Database Version: 17.1.0
Q-line POS Version: 17.2.3 Download Q-line POS 17.2.3

+

If a webhook indicates that a customerMessage should be displayed for a certain time, the message will remain in view for as long as indicated. Even when the POS wants to show a different text on the customer display. The only exceptions to this are when the POS is switching to open or closed mode, or when the POS wants to erase the text on the customer display.

Release 17.0.0

Release Date: 2019-08-06
Database Version: 17.0.0
Q-line POS Version: 17.0.0 Download Q-line POS 17.0.0 · Download MSI

+

Webhooks: It is now possible to request the running of a customAction from a backgroundPoll response. You can do this through requestCustomAction.

+

Webhooks: When calling a customAction, an already completed session is first cleared before calling the webhook.

+

Webhooks: It is now possible to clear the customer display of any messages with the clearCustomerScreen property. Messages on the customer display now also have a finite amount that they will be shown. This time defaults to five seconds and can be adjusted through the settings or by adding the property customerMessageDisplayTime to the webhook response that also contains the desired customerMessage.

+

Webhooks: A few improvements in the external payment flow (externalPayment). It is now also possible to confirm a payment directly from a startExternalPayment. When this is used, the payment process will never enter the pollExternalPayment phase.

+

Webhooks: Small tweaks in the communication log report, which makes it easier to see things like whether a request was cancelled, or timed out. Also the response time is displayed correctly again.

+

Webhooks: The communication log is written at an earlier stage, and ammended later. That is to say, the log is written as soon as the request is sent, and not after a potential response is received. This gives more insight into webhook requests that were sent, but were not received or replied to (in a timely manner) by the endpoint.

+

Webhooks: Four new webhooks have been added, namely startPOS, openPOS, closePOS and exitPOS. Respectively, these are called when starting the POS, opening the POS, closing the POS and exiting the POS. Usually, startPOS and openPOS are called together and in that order and the same goes for closePOS and exitPOS. When using the "POS closed mode", it is possible to call closePOS and openPOS while the POS keeps running, using the "POS closed" button in the POS menu.

+

Webhooks: customAction buttons are now authorizable per button. You have to use the button at least once to make it appear in the authorization list under Back-office > POS > Webhook customAction.

+

Webhooks: It is now configurable whether or not the text "(not blocked)" should be displayed when dealing with a non-blocked externalCardScan.

»

The Webhook icon in the top bar has been removed for now. The animation here could cause strange hangups on slow (?) systems.

»

Webhooks: The properties messageDisplayTime and customerMessageDisplayTime now also work with the scanCode response.

Release 16.2.2

Release Date: 2019-07-11
Database Version: 16.1.2
Q-line POS Version: 16.2.5 Download Q-line POS 16.2.5 · Download MSI

Webhooks: Solved an issue with the combination of removeSessionLine and lineDeletions.

Release 16.2.0

Release Date: 2019-06-27
Database Version: 16.1.2
Q-line POS Version: 16.2.5 Download Q-line POS 16.2.5 · Download MSI

+

Webhooks: It is now possible to send a customerMessage of two lines to the customer display. The second text line can be separated from the first by a newline-character: \n

+

Webhooks: It is now possible to respond with a prepayTable property. This can be used to do a prepayment on a table order.

+

Webhooks: It is now possible to respond with an externalCardScan property. This can "simulate" an actual card scan from the POS, with a specific balance and other card details. The card details will be displayed on the POS screen and the customer display, as part of the totals underneath the virtual screen receipt.

+

Webhooks: In case of a manual cancellation of an externalPayment flow, there will be no separate notification of this fact to the webhook endpoint. This is because as part of the externalPayment flow, there will always be a requestCancelExternalPayment that follows the manual cancellation, which basically carries the same message for the endpoint (namely that the payment should be cancelled).

+

It is now possible to lock the session solely for additions (you can still reduce amounts on the session). To trigger this behaviour, respond with the property lockSessionForAdditions in the JSON reply.

+

Webhooks: It is now possible, in a reply where you return a message or customerMessage, to use the property displayTime, messageDisplayTime or customerMessageDisplayTime to set a minimum amount of seconds that you want the message to stay on screen. This can be useful when the POS has been configured to remove the webhook popup as soon as possible, but you still want to display an important message to the user. This setting delays the hiding process with the set amount of seconds.

+

New webhook, backgroundPoll, which is called continously while the software is running.

+

New webhook, printBill, which is called when printing the bill of a table.

Webhooks: When an article with a question-price is added through lineAdditions, but a price is also included in the response, the price-popup will no longer be shown. wordt met een vraagom-prijs, maar er wordt ook direct een gewenste prijs meegegeven, dan wordt de vraagom-popup nu niet meer getoond.

Webhooks: In case of a manual cancellation of a webhook, there will no longer be an error message sent to the POS interface telling the user that the webhook is cancelled. Because the user already knows this, since they were the one that initiated the cancellation manually.

Solved an issue where the webhook popup would show earlier than expected (earlier than the configured delay time). The popup will now also be hidden when the webhook responds with a dialog. And after answering the dialog, it will be shown again only after the configured delay time has elapsed again.

Release 16.0.3

Release Date: 2019-06-19
Database Version: 16.0.0
Q-line POS Version: 16.0.3 Download Q-line POS 16.0.3 · Download MSI

When the externalPayment webhooks were used together with (table) orders, the POS would show an error message.

Release 16.0.0

Release Date: 2019-05-09
Database Version: 16.0.0
Q-line POS Version: 16.0.3 Download Q-line POS 16.0.3 · Download MSI

The POS no longer stays stuck in webhook communication when it receives lineDeletions in reply to a removeSessionLine.

Release 15.1.0

Release Date: 2019-04-09
Database Version: 15.1.0
Q-line POS Version: 15.1.1 Download Q-line POS 15.1.1

+

With the webhook response vatMethodChange, it is now possible to change the current VAT method of the POS for the duration of the session. Valid values are: "inclusive" (VAT included), "exclusive" (VAT excluded) and "shifted" (VAT shifted).

+

The processing of webhook responses has become a bit more relaxed, because certain fields can now be returned in multiple ways. Eg. the title of a dialog can now be returned through both dialog.dialogTitle and dialog.title.

+

Added support for changing the caption of a customAction button, by responding with customActionChange.

Solved an issue where webhooks wouldn't work if the server returned headers more than once. E.g. Set-Cookie.

Release 14.1.0

Release Date: 2019-03-06
Database Version: 14.1.0
Q-line POS Version: 14.1.2 Download Q-line POS 14.1.2

+

Webhooks: Where available, the kitchen events now also contain customer data, in the relation object.

+

Webhooks: It is now possible to adjust the final payment of an external payment. You do this by responding with an adjusted externalPayment.finalAmount. This is useful when a payment method has applied additional discounts on a receipt, or when you want to indicate that more has been paid than necessary which may mean the cash register should give change to the customer.

Release 14.0.2

Release Date: 2019-02-08
Database Version: 14.0.0
Q-line POS Version: 14.0.3 Download Q-line POS 14.0.3

+

Webhooks: It is now possible to use an Endpoint URL without SSL (http instead of https), as long as the address is local or private, eg. http://localhost, http://127.0.0.1, http://192.168.*.*.

Release 13.1.0

Release Date: 2019-01-15
Database Version: 13.0.0
Q-line POS Version: 13.1.0 Download Q-line POS 13.1.0

+

Webhooks: The following properties have been added to the relation data object:

  • bankAccountNumber (het bankrekeningnummer van de geselecteerde klant)
  • extRelationId (the external reference of the selected customer)
  • address (the street name of the selected customer)
  • zipcode (the zipcode of the selected customer)
  • city (the city of the selected customer)
  • country (the country of the selected customer)
  • deliveryAddress, deliveryZipcode, deliveryCity,deliveryCountry (see above, but for the delivery address)
  • vatNumber (the VAT registration number of the selected customer)
  • commerceNumber (the Chamber of Commerce registration number of the selected customer)

Release 11.3.0

Release Date: 2018-09-25
Database Version: 11.1.3
Q-line POS Version: 11.3.4 Download Q-line POS 11.3.4

+

Webhooks:

  • Added support for external payments, with the following events:
    • startExternalPayment
    • pollExternalPayment
    • requestCancelExternalPayment
    • cancelExternalPayment
  • Added updateSessionLine
  • Added an article filter to add/update/removeSessionLine
  • Added customAction toegevoegd
  • Webhooks can now be Polling, which means they will keep running until confirmed or cancelled
+

Webhooks: It is now possible for lines to be deleted by a webhook that were not added by a webhook.

+

All webhooks now also send (if applicable) the currently signed in employee (through the field employeeNumber).

Release 11.1.12

Release Date: 2018-09-12
Database Version: 11.1.0
Q-line POS Version: 11.1.14 Download Q-line POS 11.1.14

+

Webhooks: It is now no longer possible to mark an article as "Loss", when it has been locked by a webhook.

+

Webhooks: When opening a table order on a cash register, which was made through an handheld, you will no longer see the message "De aangeslagen artikelen worden opgeslagen op tafel x".

Release 11.1.4

Release Date: 2018-06-29
Database Version: 11.1.0
Q-line POS Version: 11.1.14 Download Q-line POS 11.1.14

+

Solved an issue with Webhooks.

Release 11.1.3

Release Date: 2018-06-28
Database Version: 11.1.0
Q-line POS Version: 11.1.14 Download Q-line POS 11.1.14

Small bugfixes.

Release 11.1.2

Release Date: 2018-06-27
Database Version: 11.1.0
Q-line POS Version: 11.1.14 Download Q-line POS 11.1.14

+

Webhooks: When a webhook consumer locks a session (through lockSession), it is still able to modify the session through lineAdditions, lineChanges and lineDeletions.

+

Webhooks: In the sender-object you will now also be able to find whether or not the POS is currently in the payment screen. This is indicated by the property: paymentStarted: true of false

Release 11.1.1

Release Date: 2018-06-21
Database Version: 11.1.0
Q-line POS Version: 11.1.14 Download Q-line POS 11.1.14

+

Webhooks: The event completeSession now also sends the property session.table when it was a table session that was completed.

+

Webhooks: session.table.subNumber is now always filled.

+

The Webhooks module is now available on Slaves.

Release 11.1.0

Release Date: 2018-06-18
Database Version: 11.1.0
Q-line POS Version: 11.1.14 Download Q-line POS 11.1.14

+

Webhooks: It is now possible to add text lines through lineAdditions.

»

Webhooks: When a webhook adds a line to the session (through lineAdditions), this same webhook no longer receives an addSessionLine event about this. After all, the webhook should know that it added the line.

Webhooks: Table numbers are now correctly sent again. This was a temporary issue related to the transition to table sub numbers. When applicable, an additional subNumber property is now also sent.

Release 9.1.1

Release Date: 2018-02-20
Database Version: 9.1.0
Q-line POS Version: 9.1.3 Download Q-line POS 9.1.3

Special change for Webhooks: When adding a line through lineAdditions, the supplied text, priceIncl, quantity and externalDiscount are now also used instead of ignored.

Release 8.0.8

Release Date: 2018-02-08
Database Version: 8.0.2
Q-line POS Version: 8.0.8 Download Q-line POS 8.0.8

Special change for Webhooks: When adding a line through lineAdditions, the supplied text, priceIncl, quantity and externalDiscount are now also used instead of ignored.

Release 8.0.0

Release Date: 2017-10-31
Database Version: 8.0.0
Q-line POS Version: 8.0.1 Download Q-line POS 8.0.1

+

Added support for webhooks.

With webhooks, information about the current receipt can be sent from the cash register to a configuratble URL. By replying to thist request, you can also do things like changing the contents of the receipt, or influencing the software flow. E.g. applying discounts, adding receipt lines, and printing additional information on the receipt. It is also possible to ask questions from the user.

See the Developers-site for a technical explanation.