Set Up the Order Confirmation Webhook

Owned by Former user (Deleted)
Last updated: Dec 04, 2023 by Andres Toledo
2 min read

In this article, you will learn how to set up the order confirmation webhook and enable email notifications to notify salespeople if there is an error during the synchronization process with an external system so they can reconfirm the orders once the issue is solved.

Step one: Create the Order Confirmation Webhook in Your System

When creating the endpoint in your system, it is important to consider the following details:

Request

Content-Type: URL Parameters

Method: GET

Parameters

invoiceId (required)(integer)

Komet Sales internal Invoice ID.

This parameter must be the last in the webhook URL to enable the system to retrieve the invoice details using the pickticket.details.list method.

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.

token (optional)(string)

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.

URL Example

https://theexternalsystem.com/orderFromKomet?token=ANY_TOKEN&companyId=25434&invoiceId=131313

Response

Content-Type: application/JSON

Parameters

status (boolean)

Result of the request.

Valid values: 0 = Error | 1 = Success

message (string)

In this parameter, you can enter a customized message describing the status. This message will be reflected in Komet Sales.

error (string)

In this parameter, you can enter a customized error message describing the status. This message will be reflected in Komet Sales.

Response Examples

Success

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

Error

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

Back to top

Step two: Set up the Order Confirmation 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 Confirmation Webhook from the Integrations group of settings.

  3. Enter the URL that Komet Sales will call when orders are confirmed.

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

  5. Click on Save.

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

Add your endpoint from the Integrations settings.

Back to top

Notification sample

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

Email notification.

Back to top

Related Articles



Peacock