Webhook

Webhook can be used for you to automatically send messages via Telegram to yourself for you to be notified of recent purchases made by your customers. You can also use this webhook to send your customer's purchase information into your Google Excel and more.

This Webhook function is only available on Standard, Premium and Ultimate plan subscriptions.

Webhooks Setup

1. Click on Settings (1) and scroll down until you find the Webhooks section (2).

2. Press the Add Webhook button to add your webhook.

3. Select Webhook Status (1), then enter the name you want to assign in the Name field (2) and enter the webhook link in the Callback URL field (3).

4. Press the '||' icon to stop receiving data from your webhook and press it again to resume receiving data from the webhook. Press the trash can icon to delete the webhook.

Webhook Data

In Commerce, you can use the webhook to pull data for each:

Order Paid	Trigger when you mark your order as paid or the customer's order successfully makes a payment
Order Shipped	Trigger when you enter the tracking number on the customer's order
Checkout Abandoned	Trigger when a customer does not complete payment within 60 minutes
Checkout Completed	Trigger when the customer successfully checkout and reaches up to the thank you page
Checkout Updated	Trigger when customers receive the Thank you Page Offer (TYPO) promotion you offer
Order Status Processing	Trigger when you change the status of a customer's order to Processing
Order Status Completed	Trigger when you change the status of a customer's order to Completed

Here, we include the values ​​that you can pull.

Parameters: {{ checkout}} Description: Checkout data Example: [Collection]

Parameters: {{ checkout.id}} Description: Id for checkout data Example: 1262140

Parameters: {{ checkout.domain}} Description: Domain/Subdomain of your store Example: mirfaith.myshoppegram.com

Parameters: {{ checkout.url}} Description: Your store link Example: https://mirfaith.myshoppegram.com

Parameters: {{ checkout.currency}} Description: Currency used in your store Example: MYR

Parameters: {{ checkout.total}} Description: The amount of payment charged Example: 10

Parameters: {{ checkout.shipping}} Description: The shipping rates you have set Example: 0

Parameters: {{ checkout.rate}} Description: The name of the shipping rates that the customer has chosen Example: FREE SHIPPING COD

Parameters: {{ checkout.completed_at}} Description: The date and time the customer successfully made the payment Example: 2021-03-03T22:58:32+08:00

Parameters: {{ checkout.created_at}} Description: The date and time the customer wants to make the payment Example: 2021-03-03T22:58:17+08:00

Parameters: {{ checkout.items}} Description: Data items/variants in checkout Example: [Collection]

Parameters: {{ checkout.items[].product}} Description: Product data at checkout Example: [Collection]

Parameters: {{ checkout.items[].product.name}} Description: The name of your product Example: Test

Parameters: {{ checkout.items[].product.sku}} Description: SKUs for your product variants Example: 123456

Parameters: {{ checkout.items[].name}} Description: The name of your product variant Example: 2 Unit/ Hitam

Parameters: {{ checkout.items[].currency}} Description: Currency used in your store Example: MYR

Parameters: {{ checkout.items[].price}} Description: The price of your product variants Example: 10

Parameters: {{ checkout.items[].quantity}} Description: The quantity of your variant product that is at Checkout Example: 1

Parameters: {{ checkout.items[].subtotal}} Description: The total price of the variant product at Checkout Example: 10

Parameters: {{ checkout.customer}} Description: Customer data that checkout on your website Example: [Collection]

Parameters: {{ checkout.customer.first_name}} Description: The first name of the customer who checked out on your website Example: Abu

Parameters: {{ checkout.customer.last_name}} Description: The last name of the customer who checked out on your website Example: Ali

Parameters: {{ checkout.customer.phone}} Description: The phone number of the customer who checked out on your website Example: 60123456789

Parameters: {{ checkout.customer.email}} Description: Email customers who checkout on your website Example: [e-mail]

Parameters: {{ checkout.shipping_address}} Description: Shipping data entered during checkout on your website Example: [Collection]

Parameters: {{ checkout.shipping_address.first_name}} Description: The first name entered on the shipping page during checkout on your website Example: Nur

Parameters: {{ checkout.shipping_address.last_name}} Description: The last name entered on the shipping page during checkout on your website Example: Aishah

Parameters: {{ checkout.shipping_address.phone}} Description: Phone number entered on the shipping page during checkout on your website Example: 601122334455

Parameters: {{ checkout.shipping_address.email}} Description: Email entered on the shipping page during checkout on your website Example: [e-mail]

Parameters: {{ checkout.shipping_address.address1}} Description: Address entered on the shipping page during checkout on your website Example: Persiaran Permata Perdana

Parameters: {{ checkout.shipping_address.address2}} Description: Address line 2 (If any) entered on the shipping page during checkout on your website Example: -

Parameters: {{ checkout.shipping_address.zip}} Description: Postal code entered on the shipping page during checkout on your website Example: 63000

Parameters: {{ checkout.shipping_address.city}} Description: The city entered in the shipping page during checkout on your website Example: Selangor

Parameters: {{ checkout.shipping_address.state}} Description: The state entered in the shipping page during checkout on your website Example: Cyberjaya