Menu

The hook object

The HOOK object is used to generate "events". These events are addressed to your information system according to the object status with which they interact.

You can receive HTTP notifications on your infrastructure that you have previously set up for one or more points of sale.

All API objects are available in the Hooks.

In other words, during each interaction with an object due to a status or data update, an HTTP request will be sent to the set up server to warn you about the operation that is currently taking place. Keep in mind that you can't setup 2 HOOk for the same endpoint.

For example, a successful or failed transaction, a new subscription creation, a new customer, an unpaid... 

The remote server must confirm the correct receipt of the request by returning a 2XX code. If not, a new request will be sent every 5 minutes for 2h.

2 types of WEBHOOKS are available in the plateform :
- the ones connected to one or many point of sales. You can create many HOOK as long as your Point of Sales are differents.
- the ones connected to your account. Those one can't be duplicated. You can't create more that one HOOK profile per endpoint.