| Anchor | ||||
|---|---|---|---|---|
|
| Excerpt | ||
|---|---|---|
In this article, you will learn how to set up the order cancellation webhook and enable email notifications to notify salespeople if there is an error during the synchronization process with an external system so they can cancel the orders again once the issue is solved.
|
Table of Contents
| Table of Contents | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Step one: Create the Order cancellation Webhook in Your System
When creating the endpoint in your system, it is important to consider the following details:
Request
URL: https://{theexternalsystem.com}/orderFromKomet
Content-Type: application/JSON
Method: POST
Header
authenticationToken (optional)(string:50)
Komet Sales Company Token. You can use this optional parameter to identify yourself when integrating with external systems or extract it from the token. The method chosen will depend on your specific operation.
Parameters
invoiceId (required)(integer)
Komet Sales internal Invoice ID.
companyId (optional)(string)
Komet Sales Internal Company ID. You can use this optional parameter to identify yourself when integrating with external systems or extract it from the token. The method chosen will depend on your specific operation.
Request Example
| Code Block |
|---|
{
"companyId":6316,
"orderId":6908
} |
Response
Content-Type: application/JSON
Parameters
status (boolean)
Result of the request.
Valid values: 0 = Error | 1 = Success
message (string)
This parameter allows you to enter a customized message describing the status. The message will be reflected in Komet Sales.
error (string)
This parameter allows you to enter a customized error message describing the status. The message will be reflected in Komet Sales.
Response Examples
Success
| Code Block |
|---|
{
"status":"1",
"message":"<<Custom Success Message>>"
} |
Error
| Code Block |
|---|
{
"status":"0",
"error":"<<Custom Error Message>>"
} |
Step two: Set up the Order cancellation Webhook
Once you have created the endpoint in your system, you need to add it to your Komet Sales account. To add your endpoint, do the following instructions:
Go to Setup and select Settings.
Click on Order Cancellation Webhook from the Integrations group of settings.
Check the box to enable the webhook.
Enter the URL that Komet Sales will call when orders are canceled.
Enter the email addresses that the system will notify when an error occurs in the external system in the Error Notification field. You can enter up to 5 email addresses.
Click on Save.
| Info |
|---|
This URL is the one you created from your external system in step one. |
Notification sample
This is an example of the email notification the users will receive.
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|