Our webhooks automatically send notifications about important events, reducing the need for frequent API polling.
\nThis guide explains how to set up, manage, and handle webhooks efficiently to ensure seamless data synchronization.<\/p>\n
The list of available events can be found in the documentation<\/a>.<\/p>\n First, you need to register a webhook. This is done using the POST \/api\/webhooks<\/a> endpoint.<\/p>\n For example, if you want to be notified about new orders<\/strong>, send:<\/p>\n The response to the webhook registration request looks like this:<\/p>\n From now on, whenever a new order is created in the e-shop, Shoptet will invoke The event notification contains the e-shop identification ( Now, we are likely interested in the details of this order. Based on The above demonstrated how to register a new webhook. When doing so, it is not possible to register more than one URL under for a single event<\/strong> (e.g., It is also important to remember that webhooks are registered separately for each installation (i.e., each e-shop and add-on)<\/strong>. Therefore, it is not possible to register a single webhook for an add-on that would send notifications from all e-shops that install it. This gives you the flexibility to register webhooks only for the e-shops where they are needed (for example, when a user disables notifications). Additionally, you can use URLs specific to an e-shop\u2014making it easier to identify the shop\u2014such as The registration or modification of these \u201cadd-on events\u201d is not subject to any approval process; they take effect immediately. These events are fully controlled by the add-on\u2019s author.<\/p>\n Registered webhooks are valid for one add-on and one e-shop at a time. It is not possible to register or read webhooks for any other add-on, even if it is from the same developer and for the same e-shop, as they are linked to the specific installation of the add-on.<\/p>\n A notification sent to a webhook URL must be confirmed by the webhook using HTTP status code 200 within 4 seconds. Otherwise, we will resend the notification after 15 minutes, up to two more times (a maximum of three attempts in total). If the last notification is not confirmed, we will mark it as inactive.<\/p>\n Be careful to split the webhook notification retrieval and further processing. You should end up with 200 Ok once the webhook notification is retrieved properly, otherwise the same notification will be sent again (if e. g. your script faces a problem in later processing and the response finally returns The notifications made on the webhooks are logged, including the number of repetitions, status, timestamps and whether they are active. The author of the addon has theExample of webhook usage<\/h2>\n
{\r\n \"data\"<\/span>: [\r\n {\r\n \"event\"<\/span>: \"order:create\"<\/span>,\r\n \"url\"<\/span>: \"https:\/\/myapplication.tld\/new_order.php\"<\/span>\r\n }\r\n ]\r\n}\r\n<\/code><\/pre>\n{\r\n \"data\"<\/span>: {\r\n \"webhooks\"<\/span>: [\r\n {\r\n \"id\"<\/span>: 123<\/span>,\r\n \"event\"<\/span>: \"order:create\"<\/span>,\r\n \"url\"<\/span>: \"https:\/\/myapplication.tld\/new_order.php\"<\/span>,\r\n \"created\"<\/span>: \"2025-03-02T17:22:02+0200\"<\/span>,\r\n \"updated\"<\/span>: null<\/span>\r\n }\r\n ]\r\n },\r\n \"errors\"<\/span>: null,\r\n<\/span> \"metadata\"<\/span>: {\r\n \"requestId\": \"019c8c34-64f3-7328-af43-bf1e34fa39d7\"<\/span>\r\n }\r\n<\/code><\/code>} <\/code><\/pre>\nhttps:\/\/myapplication.tld\/new_order.php<\/code> via POST with the following content:<\/p>\n{\r\n \"eshopId\"<\/span>: 222651<\/span>,\r\n \"event\"<\/span>: \"order:create\"<\/span>,\r\n \"eventCreated\"<\/span>: \"2025-02-08T15:13:39+0100\"<\/span>,\r\n \"eventInstance\"<\/span>: \"2025000057\"<\/span>\r\n}\r\n<\/code><\/pre>\neshopId<\/code>), event type (order:create<\/code>, meaning order creation), time of creation, and the instance concerned (eventInstance<\/code>) \u2014 in our case, the order with number 2018000057<\/code>.<\/p>\neshopId<\/code>, we need to find the correct OAuth access token<\/code>. Using the standard method, we will request an access token<\/code> and then retrieve the order using GET \/api\/orders\/2018000057<\/a>.<\/p>\nWebhooks registration<\/h2>\n
order:update<\/code>). URLs using ports 80<\/code>, 8080<\/code>, 443<\/code>, and 8443<\/code> are permitted.<\/p>\nhttps:\/\/call.me\/order\/shopId134<\/code>.<\/p>\nFurther endpoints for the webhook content<\/h2>\n
\n
Notifications<\/h2>\n
500<\/code>, 422<\/code> etc.).<\/p>\n
\npossibility to read the logs of the implemented requests for webhooks using the endpoint GET \/api\/webhooks\/notifications<\/a>.<\/p>\n