Clicksend Notification Integration

Clicksend Notification Integration

OMS has the ability to send SMS order confirmations via a 3rd party service called Clicksend.


SMSs will be sent to the telephone number stored in the "Shipping Telephone" field. If the telephone number does not have an international dialling prefix (E.164 format) then OMS will attempt to use the shipping country code to determine which prefix to use.

OMS / Integration Settings

First step is to get a click send account at https://dashboard.clicksend.com/#/signup/step1/. Once an account is setup, you can obtain the username and Api key needed for authentication from the account settings.

NB: Only the Username and Api Key fields are needed for authentication. The password field can be left blank.

The Sender ID is a text or telephone number of the sender. This is a required field.
The Custom String is a reference for the sender.  It is not a required field and can be left blank.
The From Email field is also not a required field for SMS and can also be left blank
The integration uses the Message Template field (if populated) to format the SMS messages sent. This will be described in detail in the 'How it Works' section of this documentation. 

Notified Statuses list all the possible statuses an order can be in at any one point in time. A text message will be sent once an order changes status to any of the statuses ticked in the Notified Statuses.




Order Requirements

The Shipping Telephone field must be populated in OMS. This is the telephone number the SMS is going to be sent to. The telephone number should be entered in the E.164 format as seen in the screenshot below.
If the telephone number is not entered in the E.164 format, then the integration will attempt to determine the international dialling prefix for the telephone number using a two-letter country code. If a valid shipping country code is not populated, the integration will flag an error
The country code field can be left blank if the telephone number is in the E.164 format.


How it works

SMSs are only sent for statuses ticked in the Notified Statuses on the Integration settings popup.

Text messages can be sent with or without a template. If a message template is required, then the template must be entered in the Message Template field on the Integration settings popup
Please see below an example template:
{% for item in order.items %}
Great news, your "{{ item.personalisation[0].value }}" personalised order is ready to collect.


Order Number: "{{ order.external_ref }}" 
{% endfor %}
The above template picks any personalisation available on an item and the external reference on the order.

NB: You can only modify portions of the above template that is not included in braces.
NB: If you require particular information on an order to be included in the template, please get in touch with our Support team with the particular information you require.

NB: If the Message Template field is left blank, the integration automatically composes the SMS message with information about the customer name, order external reference, status description and the time the status changed as seen below:
Generic Template:
<Shipping customer name>, your order ref <order external_ref> is <statusDescription> @ <time>";

To use the generic template, the Message Template field must be left blank.


Below is an example of a SMS message sent to the API using a message template. 
{
  "messages": [
    {
      "source": "cg",
      "from": "+61422222222",
      "body": "Great news, your \"\" personalised order is ready to collect.\n\n\nOrder Number: \"WEB1720X003-f\" \n",
      "to": "+61411111111",
      "schedule": "0",
      "custom_string": "This is a test string"
    }
  ]
}


Below is an example of a SMS message sent to the API using a generic template:
{
  "messages": [
    {
      "source": "cg",
      "from": "+61422222222",
      "body": "James Crystal 1048605, your order ref WEB1720X003-f is Received @ 2020-01-14 14:10:02",
      "to": "+61411111111",
      "schedule": "0",
      "custom_string": "This is a test string"
    }
  ]
}



    • Related Articles

    • Notification Integration | Generic Filesystem

      Introduction This article has been created to show how to setup the Notification Integration that Kornit X has built to connect to a Generic Filesystem  Setup To setup the Generic Filesystem Notification integration, please head to your company and ...
    • Notification Integration | Reviews.io

      Introduction This article has been created to show how to setup the Notification Integration that Kornit X has built to connect to Reviews.io.  Setup To setup the Reviewss.io Notification integration, please head to your company and within the ...
    • Supplier Integration | PMI

      Introduction This article has been created to show how to setup the supplier integration Kornit X has built to connect to PMI.  Setup To setup the PMI supplier integration, please head to your company and within the advanced settings head to ...
    • What is a Notification Integration?

      This video covers what a notification integration in the Custom Gateway platform actually does
    • Octopush Notification Integration

      Introduction OMS has the ability to send SMS order confirmation and dispatch confirmations via a 3rd party service called Octopush . SMSs will be sent to the telephone number stored in the "Shipping Telephone" field. If the telephone number does not ...