Order Cancellation Webhook

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

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

orderId (required)(integer)

Komet Sales internal order 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

{
   "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

{
   "status":"1",
   "message":"<<Custom Success Message>>"
}

Error

{
   "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:

1. Go to Setup and select Settings.

2. Click on Order Cancellation Webhook from the Integrations group of settings.

3. Check the box to enable the webhook.

4. Enter the URL that Komet Sales will call when orders are canceled.

5. 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.

6. Click on Save.

Notification sample

This is an example of the email notification the users will receive.