ClickPost

This page guides you on how to integrate ClickPost with Contlo

By integrating ClickPost with Contlo, you can send shipment related events from ClickPost to Contlo where you can create Segments, launch Campaigns or Automations.

Prerequisites

  1. Open the Contlo dashboard and go to the App Market from the sidebar.
  2. Search and install the ClickPost app.
  3. Copy the webhook URL to add it later on the ClickPost dashboard.

Set up ClickPost

To integrate ClickPost with Contlo, follow the steps below:

  1. Open your ClickPost dashboard and go to Settings on the sidebar.
  2. On the Settings menu, go to Notifications > Overview.
  3. On the Notification Overview screen, locate the Marketing Tools channel from the table and click configure on the gateway.
  4. Click Integrate on Contlo, add the webhook URL and click Submit.
  5. To enable events and specific properties for every event from ClickPost, coordinate with your Clickpost CSM.

Events

You can use events given in the table below:

EventDescription
Out For PickupItem is scheduled for pickup by delivery service.
ShippedItem is shipped and is in transit to the destination.
Out For DeliveryItem is on its way to the delivery location.
Failed DeliveryAttempt to deliver the item was unsuccessful.
DeliveredItem successfully delivered to the specified location.
RTOReturn to Origin: Item is being returned to the sender or origin due to various reasons.
Failed Delivery ReminderNotification reminding about a failed delivery attempt.
AWB RegisteredAir Waybill (AWB) or tracking number has been registered for the shipment.
Order CancelledOrder cancelled by the customer or the system.
Return Request PlacedRequest initiated by the customer to return the item.
RTO DeliveredReturned item successfully delivered to the origin.
Reached Destination HubShipment has reached a hub or distribution center.
Pickup FailedAttempt to pick up the item for delivery is unsuccessful.
SLA BreachService Level Agreement (SLA) breach, indicating a failure to meet agreed-upon service levels.
Return Request ApprovedReturn request initiated by the customer is approved.
Return Request RejectedReturn request initiated by the customer is rejected.
Return Request ReceivedSystem has received a return request from the customer.
Return Request ClosedReturn request is processed and closed.
Out For Delivery Before Committed SLAItem out for delivery before the committed Service Level Agreement (SLA).
Out For Delivery After Committed SLAItem out for delivery after the committed Service Level Agreement (SLA).
Exchange Request PlacedRequest initiated by the customer to exchange the item.
Exchange Request ApprovedExchange request initiated by the customer is approved.
Exchange Request RejectedExchange request initiated by the customer is rejected.
Appointment Based NotificationNotification related to a scheduled appointment or delivery time.
Post Delivery Survey NotificationNotification requesting feedback or a survey after delivery.
Exchange Request ClosedExchange request is processed and closed.
Send Refund Payout LinkSending a link to the customer for processing a refund payout.
Refund Payout Link ReminderA reminder notification regarding a pending refund payout.
SLA Breach Day 3SLA breach notification on the third day, indicating a delay.
SLA Breach Day 5SLA breach notification on the fifth day, indicating a prolonged delay.
Seller ShippedNotification that the seller has shipped the item.
Seller Out For PickupThe seller's item is out for pickup by the delivery service.
Seller Out For DeliveryThe seller's item is on its way to the delivery location.
Seller Failed DeliveryThe seller's attempt to deliver the item was unsuccessful.
Seller DeliveredThe seller's item is successfully delivered to the specified location.
Seller RTOSeller-initiated Return to Origin: The item is being returned to the seller due to various reasons.
Seller AWB RegisteredThe Air Waybill (AWB) or tracking number is registered for the seller's shipment.
Seller Order CancelledThe seller has canceled the order.
Seller RTO DeliveredThe item, which was seller-initiated return, has been successfully delivered to the seller's location.
Seller Return Request ClosedThe return request initiated by the seller is processed and closed.
Seller Out For Delivery Before Committed SLASeller's item is out for delivery before the committed Service Level Agreement (SLA).
Seller Out For Delivery After Committed SLASeller's item is out for delivery after the committed Service Level Agreement (SLA).
Seller Pickup FailedThe seller's attempt to pick up the item for delivery was unsuccessful.

Event Properties

Each event has its own event properties that you can use to gather certain information. These properties should be enabled for the respective event on the ClickPost dashboard.

There are two types of event properties-

Default event properties

These properties available on the automation tags in Contlo for all the events.

PropertyDescription
customerPhonePhone number of the customer associated with the notification event.
notificationEventIdUnique identifier for the notification event.
referenceNumberReference number or identifier linked to the event.
clickpostStatusCodeStatus code assigned by ClickPost indicating the status of the notification event.
waybillAir Waybill (AWB) or tracking number associated with the order.
orderIdUnique identifier for the order linked to the notification event.
is_rvpBinary indicator (e.g., 0 or 1) specifying if the item is a return-to-vendor.
customerNameName of the customer associated with the notification event.`

Custom event properties

These properties are not available on Contlo but you can insert these properties in automation variables as {{event.property_name}} .

PropertyDescription
itemsDetails of the items included in the order.
codValueCash on Delivery (COD) value associated with the order.
invoiceValueTotal value mentioned in the invoice for the order.
courierPartnerNameName of the courier partner responsible for the delivery.
orderTypeType of order, e.g., standard, express, etc.
enterpriseNameName of the enterprise or business associated with the order.
quantityNumber of items included in the order.
trackingLinkLink providing tracking information for the order.
eddMinSlaMinimum Estimated Delivery Duration Service Level Agreement (SLA).
eddMaxSlaMaximum Estimated Delivery Duration Service Level Agreement (SLA).
forwardReferenceNumberReference number associated with forwarding the order.
forwardWaybillAir Waybill (AWB) or tracking number for the forwarding order.
courierPartnerPhoneContact number for the courier partner.
courierPartnerEmailEmail address of the courier partner.
channelNameThe channel through which the order was placed.
deliveryDateThe scheduled delivery date for the order.
deliveryAddressThe address to which the order is to be delivered.
eddMinDateMinimum Estimated Delivery Date.
eddMaxDateMaximum Estimated Delivery Date.
trackingPageOrderLinkLink to the tracking page specific to the order.
invoiceUrlURL link to the invoice associated with the order.
labelUrlURL link to the label or shipping document for the order.
itemLevelQuantityThe quantity of each item in the order.
resellerNameName of the reseller or intermediary involved in the order.
rejectReasonReason for rejecting the order.
colorColor of the ordered item.
brandBrand name of the ordered item.
sizeSize of the ordered item.
itemLevelHtmlDetailsHTML-formatted details specific to each item in the order.
orderDateThe date when the order was placed.
returnReferenceNumberReference number associated with the return request.
returnPickupDateThe scheduled date for the pickup of the returned items.
returnAddressThe address to which the return is to be sent.
returnPlacedDateThe date when the return request was initiated.
failedDeliveryReasonReason for the failed delivery attempt.
failedPickupReasonReason for the failed pickup attempt in return.
finalRefundAmountThe final amount to be refunded after processing the return.
payoutLinkLink for processing the payout or refund.
dropStartTimeThe start time for item drop-off or delivery.
dropEndTimeThe end time for item drop-off or delivery.

Create an automation flow

Once you have integrated Contlo with ClickPost, follow the steps below to create an automation flow:

  1. Open the Contlo dashboard and go to the Automations from the sidebar and click Create Automation.
  2. On the Choose a template screen, click the Build From Scratch.
  3. On the Automation editor, click Set a trigger on the canvas.
    1. On the Trigger pane, choose a ClickPost even from the dropdown that acts as a trigger for the automation.
    2. Set up other filters as per requirement.
  4. From the left sidebar, drag the message block through which you want to send information to the user.
  5. The following tags are available in automation:
    1. invoiceValue
    2. trackingLink
    3. waybill
    4. codValue
    5. courierPartnerName
    6. quantity
    7. orderId
  6. Once your automation is configured, click the Launch Automation button to make the automation active.

Create a segment

Follow the steps below to create a new segment:

  1. On the Contlo dashboard, go to Audience > Segments > Create Segment and choose the type of segment as per your requirement.
  2. In the Segment Name field, name your segment for ease of tracking later on the dashboard.
  3. In Segment Criteria dropdown,
    1. Select What someone has done/not done
    2. Pick a ClickPost event as per requirement to filter your audience.
    3. Choose the remaining Segment Criteria as per your need.
  4. Click on Create Segment

All the contacts that fall under this category would now populate in the total audience in the segment made.