Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
topofpage
topofpage

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.

Tip

User Roles: Admin.

Table of Contents

Table of Contents
maxLevel2
minLevel2
include
outlinefalse
indent
excludeTable of Contents
typelist
printablefalse
class

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

Body

invoiceId (required)(integerorderId (long)

Komet Sales internal Invoice order ID.


companyId (optionallong)(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 operationinternal Company ID.

Request Example

Code Block
{
   "companyId":6316,
   "orderId":6908
}

Response

Content-Type: application/JSON

Parameters

Body

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

Response Example

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

Error

code
{
   "status":"0",
   "error":"<<Custom Error Message>>"
}

Step two: Set up the Order

cancellation

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 WebhookWebhooks from the Integrations group of settings.

  3. Check the box to enable the webhookSelect Order Cancellation from the dropdown list.

  4. Enter the URL that Komet Sales will call when orders are canceledthis webhook is triggered.

  5. Select your authentication type:

    1. Basic. Enter your username and password.

    2. Bearer Token. Enter your authentication token.

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

  7. Click on Save.

Info

This URL is the one you created from your external system in step one.

cancellationwebhook.gifImage Removedwebhook config.gifImage Added

Notification sample

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

Image Removedimage-20240731-162414.pngImage Added

Back to top


Filter by label (Content by label)
showLabelsfalse
max5
titleRelated Articles
cqllabel in ( "integrations" , "external-system" , "setup" )


We've encountered an issue exporting this macro. Please try exporting this page again later.