Introduction & Previous Concepts
In the system is possible to notify certain events to a channel. If you don’t have added any notification channels please check out this document How to create a notification channel
Procedure
In the menu, go to Integrations.
Click on Configuration in the System Notifications card.
You will see a list of 8 notification events.
Order completed: It gets triggered when a successful order is closed. In admin, quote or shop sells it happens in a successful purchase. In funnels, it happens when a user reaches the thank you page or after 30 minutes after the first purchase in a funnel page (this is to avoid the scenario when a customer purchases but never goes to the thank you page).
Contact created: Is called when a lead is created/reactivated in the system.
Shipping tracking info updated: It happens when we updated the tracking information of an order.
Product conflicts: Called when a product conflict occurs (a customer who purchased a digital product that he already has).
Transaction declined: When a purchase transaction gets rejected in the system. Because this is at the transaction level (in funnels an order can have many transactions if upsells are involved), this event could be triggered many times inside a funnel purchase. For example, the cart page sale was approved but all the next upsells were declined due to insufficient funds.
Refund applied: When a refund/void occurs.
Subscription canceled: When a subscription gets canceled.
Approved transaction: When a purchase transaction succeeds in the system. Because this is at the transaction level (in funnels an order can have many transactions if upsells are involved), this event could be triggered many times inside a funnel purchase. For example, the cart page sale was approved and all of the next upsells were also purchased.
If the event you want to use is disabled, enable it by toggling the switch on its right. On the contrary, if currently enabled, click over the event name.
You will see a list of the current channels added to this event (the list will be empty if no channels were attached previously).
Click on the bottom right button to attach a channel.
You will see a form with these fields:
Channel: You can select one of your channels created before. If don't have any, click on the Add button on the right, if you need to add a new channel please read this document first How to create a notification channel
Sources: We have 3 sources: Admin, Shop, and Funnel. Every contact, order, and subscription is related to one of these 3. You can specify if you want to notify only if the event happened on some specific sources.
Click on save and you will see that the channel was successfully linked to the event.
If you click on the 3 vertical dots on the right, you will see two options available:
Edit: Here you are able to update the sources.
Delete: You can remove the channel to being notified of this event.
Postback payloads
Here will show you some examples of payloads that you can receive when notifying postback channels.
Order completed and Shipping tracking info
{
"id": "ecc0f155-9487-4d74-9598-35a667f46fcf",
"number": 174,
"date": "2022-06-29 23:27:38",
"source": "funnel",
"env": "production",
"recurrent": false,
"subtotal": 89,
"discount": 20,
"subtotal_tax": 5.7,
"shipping": 3,
"shipping_tax": 0.25,
"total": 77.95,
"coupon": {
"id": "b5302365-6bd4-442a-9109-62c00bc0a814",
"code": "20bucksoff"
},
"items": [
{
"id": "4252ff43-ff65-4db6-96fa-94c9888830e8",
"product": {
"id": "56fc34e1-ff89-453b-915d-88946abe2b2e",
"product_variation_id": "694efbc7-0619-4920-ab59-18231f959215",
"name": "Ebook",
"type": "digital",
"sku": "34qxklq6yK3Q",
"upc": "0",
"ean": "0",
"isbn": "0"
},
"plan": null,
"hard_cost": 0,
"unit_price": 27,
"quantity": 1,
"subtotal": 27,
"discount": 6.07,
"subtotal_tax": 1.73,
"shipping": 0,
"shipping_tax": 0,
"total": 22.66,
"offer": null
},
{
"id": "b3d26888-a8a4-4eb3-8831-56fffe71588c",
"product": {
"id": "4620fb70-ca2d-474a-af87-d585c78ba15c",
"product_variation_id": "e0694fd4-246f-4067-ba11-ae35f5aaf277",
"name": "Super Protein",
"type": "physical",
"sku": "sp10",
"upc": "0",
"ean": "0",
"isbn": "0"
},
"plan": null,
"hard_cost": 0,
"unit_price": 47,
"quantity": 1,
"subtotal": 47,
"discount": 10.56,
"subtotal_tax": 3.01,
"shipping": 2.28,
"shipping_tax": 0.19,
"total": 41.92,
"offer": null
},
{
"id": "b0e295a9-e4a6-4ba0-85be-d895700c5374",
"product": {
"id": "4458c7ce-d527-45db-98a6-4e1032f7c113",
"product_variation_id": "fb13ecfd-81eb-4141-ab34-a858e1a2b595",
"name": "Supplement X",
"type": "physical",
"sku": "sux",
"upc": "0",
"ean": "0",
"isbn": "0"
},
"plan": {
"id": "c5ce704b-6cda-4f9a-b77a-48286b6db71c",
"product_variation_plan_id": "86991811-7ceb-4ccb-a6a2-16b776b04d70",
"name": "1 Bottle Monthly",
"type": "service_unlock_all",
"period": "monthly",
"quantity": 1,
"unit_price": 15,
"shipping_price": 0,
"total": 15
},
"hard_cost": 0,
"unit_price": 15,
"quantity": 1,
"subtotal": 15,
"discount": 3.37,
"subtotal_tax": 0.96,
"shipping": 0.72,
"shipping_tax": 0.06,
"total": 13.37,
"offer": {
"id": "e7bc33a6-fed5-4ccc-a832-c791cf318df9",
"name": "Special Offer",
"slug": "special-offer"
}
}
],
"contact": {
"id": "c6d7b0fa-ab37-4b6e-a8ea-60368d67e271",
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@domain.com"
},
"agent": {
"id": "1ba01aac-4c65-4151-a37d-b433aa117d2c",
"first_name": "Juan",
"last_name": "Perez",
"email": "jperez@domain.com"
},
"address": {
"id": "29ca5718-5749-4976-8489-985971eadf64",
"first_name": "John",
"last_name": "Doe",
"country": "US",
"state": "TX",
"city": "Austin",
"line": "11801 Stonehollow Drive",
"line2": null,
"zip_code": "78758",
"references": null
},
"tracking": {
"id": "1ed0ca50-bc60-46a6-a020-87dac1110725",
"ip": "50.86.49.128",
"affiliate_id": "2",
"fbclid": null,
"gclid": null,
"utm_campaign": "Special campaign",
"utm_source": "custom_source",
"utm_medium": "email",
"utm_term": null,
"utm_content": null,
"other_params": {
"SID": "4354"
}
},
"payment_method": {
"id": "fcde851e-7d93-4fd6-aaed-8e0a3e37aa0b",
"type": "card",
"brand": "visa",
"last4": "9428",
"exp_month": "12",
"exp_year": "2025"
},
"gateway": {
"id": "2009e7a2-2bf9-450d-a3e3-46adea7a35fa",
"type": "nmi",
"name": "My NMI Gateway"
},
"funnel": {
"id": "6439e24e-1d4c-4e09-96e6-b56ca88a46ed",
"name": "My Funnel"
},
"shippings": [
{
"id": "196e4438-da05-472c-8f85-d65d7f6ce5d8",
"carrier": "fedex",
"tracking_number": "43234234234234",
"tracking_url": "http://www.fedex.com/Tracking?tracknumbers=43234234234234",
"external_id": null,
"items": [],
"created_at": "2022-06-29 20:32:17"
}
]
}
This is only an example, in some values that are objects you could receive null. For example, admin orders don’t have a funnel, you would receive a null value on the funnel key. If you need to access an object property in your end validate that such prop is no null first.
Best Result
Your channel will be added/updated/removed successfully.
Worst Result
The application will throw an Error and you will need to check if the data is not corrupted.
If after checking this you still have an error please contact support@webforcehq.com