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
- Open the Contlo dashboard and go to the App Market from the sidebar.
- Search and install the ClickPost app.
- Copy the webhook URL to add it later on the ClickPost dashboard.
Set up ClickPost
To integrate ClickPost with Contlo, follow the steps below:
- Open your ClickPost dashboard and go to Settings on the sidebar.
- On the Settings menu, go to Notifications > Overview.
- On the Notification Overview screen, locate the Marketing Tools channel from the table and click configure on the gateway.
- Click Integrate on Contlo, add the webhook URL and click Submit.
- 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:
Event | Description |
---|---|
Out For Pickup | Item is scheduled for pickup by delivery service. |
Shipped | Item is shipped and is in transit to the destination. |
Out For Delivery | Item is on its way to the delivery location. |
Failed Delivery | Attempt to deliver the item was unsuccessful. |
Delivered | Item successfully delivered to the specified location. |
RTO | Return to Origin: Item is being returned to the sender or origin due to various reasons. |
Failed Delivery Reminder | Notification reminding about a failed delivery attempt. |
AWB Registered | Air Waybill (AWB) or tracking number has been registered for the shipment. |
Order Cancelled | Order cancelled by the customer or the system. |
Return Request Placed | Request initiated by the customer to return the item. |
RTO Delivered | Returned item successfully delivered to the origin. |
Reached Destination Hub | Shipment has reached a hub or distribution center. |
Pickup Failed | Attempt to pick up the item for delivery is unsuccessful. |
SLA Breach | Service Level Agreement (SLA) breach, indicating a failure to meet agreed-upon service levels. |
Return Request Approved | Return request initiated by the customer is approved. |
Return Request Rejected | Return request initiated by the customer is rejected. |
Return Request Received | System has received a return request from the customer. |
Return Request Closed | Return request is processed and closed. |
Out For Delivery Before Committed SLA | Item out for delivery before the committed Service Level Agreement (SLA). |
Out For Delivery After Committed SLA | Item out for delivery after the committed Service Level Agreement (SLA). |
Exchange Request Placed | Request initiated by the customer to exchange the item. |
Exchange Request Approved | Exchange request initiated by the customer is approved. |
Exchange Request Rejected | Exchange request initiated by the customer is rejected. |
Appointment Based Notification | Notification related to a scheduled appointment or delivery time. |
Post Delivery Survey Notification | Notification requesting feedback or a survey after delivery. |
Exchange Request Closed | Exchange request is processed and closed. |
Send Refund Payout Link | Sending a link to the customer for processing a refund payout. |
Refund Payout Link Reminder | A reminder notification regarding a pending refund payout. |
SLA Breach Day 3 | SLA breach notification on the third day, indicating a delay. |
SLA Breach Day 5 | SLA breach notification on the fifth day, indicating a prolonged delay. |
Seller Shipped | Notification that the seller has shipped the item. |
Seller Out For Pickup | The seller's item is out for pickup by the delivery service. |
Seller Out For Delivery | The seller's item is on its way to the delivery location. |
Seller Failed Delivery | The seller's attempt to deliver the item was unsuccessful. |
Seller Delivered | The seller's item is successfully delivered to the specified location. |
Seller RTO | Seller-initiated Return to Origin: The item is being returned to the seller due to various reasons. |
Seller AWB Registered | The Air Waybill (AWB) or tracking number is registered for the seller's shipment. |
Seller Order Cancelled | The seller has canceled the order. |
Seller RTO Delivered | The item, which was seller-initiated return, has been successfully delivered to the seller's location. |
Seller Return Request Closed | The return request initiated by the seller is processed and closed. |
Seller Out For Delivery Before Committed SLA | Seller's item is out for delivery before the committed Service Level Agreement (SLA). |
Seller Out For Delivery After Committed SLA | Seller's item is out for delivery after the committed Service Level Agreement (SLA). |
Seller Pickup Failed | The 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.
Property | Description |
---|---|
customerPhone | Phone number of the customer associated with the notification event. |
notificationEventId | Unique identifier for the notification event. |
referenceNumber | Reference number or identifier linked to the event. |
clickpostStatusCode | Status code assigned by ClickPost indicating the status of the notification event. |
waybill | Air Waybill (AWB) or tracking number associated with the order. |
orderId | Unique identifier for the order linked to the notification event. |
is_rvp | Binary indicator (e.g., 0 or 1) specifying if the item is a return-to-vendor. |
customerName | Name 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}}
.
Property | Description |
---|---|
items | Details of the items included in the order. |
codValue | Cash on Delivery (COD) value associated with the order. |
invoiceValue | Total value mentioned in the invoice for the order. |
courierPartnerName | Name of the courier partner responsible for the delivery. |
orderType | Type of order, e.g., standard, express, etc. |
enterpriseName | Name of the enterprise or business associated with the order. |
quantity | Number of items included in the order. |
trackingLink | Link providing tracking information for the order. |
eddMinSla | Minimum Estimated Delivery Duration Service Level Agreement (SLA). |
eddMaxSla | Maximum Estimated Delivery Duration Service Level Agreement (SLA). |
forwardReferenceNumber | Reference number associated with forwarding the order. |
forwardWaybill | Air Waybill (AWB) or tracking number for the forwarding order. |
courierPartnerPhone | Contact number for the courier partner. |
courierPartnerEmail | Email address of the courier partner. |
channelName | The channel through which the order was placed. |
deliveryDate | The scheduled delivery date for the order. |
deliveryAddress | The address to which the order is to be delivered. |
eddMinDate | Minimum Estimated Delivery Date. |
eddMaxDate | Maximum Estimated Delivery Date. |
trackingPageOrderLink | Link to the tracking page specific to the order. |
invoiceUrl | URL link to the invoice associated with the order. |
labelUrl | URL link to the label or shipping document for the order. |
itemLevelQuantity | The quantity of each item in the order. |
resellerName | Name of the reseller or intermediary involved in the order. |
rejectReason | Reason for rejecting the order. |
color | Color of the ordered item. |
brand | Brand name of the ordered item. |
size | Size of the ordered item. |
itemLevelHtmlDetails | HTML-formatted details specific to each item in the order. |
orderDate | The date when the order was placed. |
returnReferenceNumber | Reference number associated with the return request. |
returnPickupDate | The scheduled date for the pickup of the returned items. |
returnAddress | The address to which the return is to be sent. |
returnPlacedDate | The date when the return request was initiated. |
failedDeliveryReason | Reason for the failed delivery attempt. |
failedPickupReason | Reason for the failed pickup attempt in return. |
finalRefundAmount | The final amount to be refunded after processing the return. |
payoutLink | Link for processing the payout or refund. |
dropStartTime | The start time for item drop-off or delivery. |
dropEndTime | The 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:
- Open the Contlo dashboard and go to the Automations from the sidebar and click Create Automation.
- On the Choose a template screen, click the Build From Scratch.
- On the Automation editor, click Set a trigger on the canvas.
- On the Trigger pane, choose a ClickPost even from the dropdown that acts as a trigger for the automation.
- Set up other filters as per requirement.
- From the left sidebar, drag the message block through which you want to send information to the user.
- The following tags are available in automation:
- invoiceValue
- trackingLink
- waybill
- codValue
- courierPartnerName
- quantity
- orderId
- 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:
- On the Contlo dashboard, go to Audience > Segments > Create Segment and choose the type of segment as per your requirement.
- In the Segment Name field, name your segment for ease of tracking later on the dashboard.
- In Segment Criteria dropdown,
- Select What someone has done/not done
- Pick a ClickPost event as per requirement to filter your audience.
- Choose the remaining Segment Criteria as per your need.
- Click on Create Segment
All the contacts that fall under this category would now populate in the total audience in the segment made.
Updated 12 months ago