Home Javascript SDK Rest API/SSO Webhooks AppMarket Login

Webhooks

to use webhooks go to app.cashcow.co.il > "Account settings" > "Api/Webhooks settings" and set your webhook URL.
The webhook triggered with HttpPost method.
body format:JSON.

new order webhook

sent when new order is completed. { "type":"neworder", "date":"03/23/2023 13:49", "order_id":1234, "order_status":"PAYMENT_DONE", "order_email":"test@test.com", "order_name":"full name", "order_price":"29.00", "order_payment_type":"PAYPAL", "order_phone":"0500000000", "order_address":"", "order_city":"", "order_street":"", "order_floor":"", "order_apartment":"", "order_building_code":"", "order_comments":null, "order_instructions":"", "order_card_gateway_payer_id":"0", "order_card_gateway_payer_token":"c147015e-7e37-469f-bd63-db9bbd411815", "order_card_gateway_digits":"0000", "order_shiping_type":"4", "order_custom_shiping_type_name":"", "order_shiping_price":"0.00", "order_referrer_type":"None", "order_referrer_name":"None", "payer_name":" ", "payer_email":"", "payer_phone":"", "store_total_new_orders":10, "store_total_orders":-1, "store_id":864, "extra_field1":"", "extra_field2":"", "extra_field3":"", "extra_field4":"", "extra_field5":"", "extra_field6":"", "order_invoice_number":null, "order_invoice_url":null, "order_tracking_code":null, "order_source_params": { "RefName":"(direct)", "UtmCmd":"(none)", "UtmCcn":"(not set)", "UtmCtr":null, "Raw":"utmcsr=(direct)|utmcmd=(none)|utmccn=(not set)" }, "order_ip_address":"1.2.3.4", "coupon_code":"", "order_branch_name":"", "customer_isnewsletter":1, // 1 = confirmed, 0 = not confirmed "payment_full_response":"", "products": [{ "Name":"product 1", "Price":7, "Qty":1, "SKU":"9Y65VBUAE0", "ExternalCode":null, "Attrs": [{"is_matrix":false, "attribute_display_name":"size", "id":31569, "sku":"m", "value":"M" }] }] }] }

new customer webhook

sent when new order is completed or new customer registered (if club members is active for the store). { "type":"new_customer", "email":"test@test.com", "first_name":"anonymous", "last_name":"last name", "phone":"050000000", "store":1111, "is_newsletter": 1 // 1 = confirmed get newsletters, 0 = not confirmed "birth_date_ticks":"11020293939" }

form sent webhook

sent when customer submit form. { "type":"formbuildersent", "email":"test@test.com", "name":"test", "phone":"05000000" ,"email":"test@test.com" ,"field1":"אפשרות 1", // html encoded text (reason:anti XSS injection) "field2":"אפשרות 1", // html encoded text (reason:anti XSS injection) "yourmessage":"test" }

Hotlead modoule

Hot leads module send webhooks when user start a new payment but did not finished.
for example: test@test.com clicks on pay button but for some reason leaves the credit card page.
the Hot leads module catch all this leads and sends a webhook with all the data.
example Json:
[ { "StoreId":111, "OrderId":22222, // lead - not payed "OrderDate":"2023-03-22T14:39:05.823", "Email":"test@gmail.com", "Phone":"0500000000", "CartLink":"https://www.test.com/CartSharerDispatcher?eoi=0EsGuazLfS8%3d&ebjmvQCgMqwxHa" } ]
"CartLink" parameter - special cart link with all cart products and data inside for the customer.