Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Checking Web Push supportability
Subscribe to the "Back in Stock" trigger
Method Objective
The method
allows checking if Web Push is available in the browser.subscribes the user to the notifications that the product is available.
Tip |
---|
You don't need to check for Web Push support, permission availability, or request it from the user. This method will do everything you need by itself. |
Syntax and parameters
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("subscriptionsubscribe_trigger", "webproduct_push_supportedavailable", callbackparams); |
Name | Type | Requirement | Description |
---|---|---|---|
callback | function | required | It's a callback function that takes a boolean value of the check result as a parameter. |
API response
params | Object | required | Object with request parameters. |
Request parameters
Name | Type | Requirement | Description |
---|---|---|---|
item | number/string | required | The product ID to notify of the product availability the user will be subscribed. |
string | optionally | The current user's Email. If not set, the subscription will be on Web Push notification. | |
webpush | boolean | optionally | This property, if true, additionally adds the Web Push notification subscription for the specified product. |
properties | Object | optionally | Additional product properties. The following are available:
|
Examples of use
Code Block | ||||
---|---|---|---|---|
| ||||
// subscribing to both channels: Email and Web Push Notifications personaclick("subscriptionsubscribe_trigger", "web_push_supported", function(supported)product_available", { item: "100500", email: "john.doe@examplestore.com", webpush: true, properties: { if (supported) { fashion_size: "XL" } }); |
Code Block | ||||
---|---|---|---|---|
| ||||
// ifsubscribing to WebEmail PushNotification is supported only personaclick("subscribe_trigger", "product_available", { } else { item: "100500", email: "john.doe@examplestore.com" }); |
Code Block | ||||
---|---|---|---|---|
| ||||
// ifsubscribing to Web Push isn't supported Notification only personaclick("subscribe_trigger", "product_available", { item: }"100500" }); |
Unsubscribe from the "Back in Stock" trigger
Method Objective
The method checks if the user has permitted to show Web Push notificationsunsubscribes the user from the notification that the product is available.
Syntax and parameters
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("subscriptionunsubscribe_trigger", "webproduct_push_subscribedavailable", callbackparams); |
Name | Type | Requirement | Description |
---|---|---|---|
callbackparams | functionObject | required | It's a callback function that takes a boolean value of the check result as a parameter. |
API response
Object with request parameters. |
Request parameters
Name | Type | Requirement | Description |
---|---|---|---|
item_ids | array | required | An array of product IDs for which the user would like to unsubscribe from the product availability notification. You can use an empty array to unsubscribe from all products. |
string | required | The current user's Email. |
Examples of use
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("subscriptionunsubscribe_trigger", "webproduct_push_subscribedavailable", function(subscibed) { if (subscibed) { item_ids: ["100500", "146", "12"], // if the user has permitted Web Push notifications } elseemail: "john.doe@examplestore.com" }); |
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("unsubscribe_trigger", "product_available", { item_ids: [], // ifunsubscribe thefrom userall hasn'tproducts yet permitted Web Push notifications or has rejected the request } }); |
email: "john.doe@examplestore.com"
}); |
Checking the "Back in Stock" trigger subscription
Method Objective
The method allows subscribing the user to Web Push notifications using only the system permissions window in the browser.
Tip |
---|
We recommend using the Programmatic Pop-Ups tool for more flexibility in configuring the user's subscription to Web Push notifications. |
checking the subscription status of the "Back in Stock" trigger.
Syntax and parameters
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("subscriptioncheck_trigger", "webproduct_push_subscribeavailable", callbackparams, success, error); |
Name | Type | Requirement | Description |
---|---|---|---|
callback | function | required | It's a callback function that takes a boolean value of the user's subscription result. |
API response
params | Object | required | Object with request parameters. |
success | Function | required | Callback-function, where the API response will be passed to. Response type: object. |
error | Function | optionally | Callback-function to be called when an error occurs (any HTTP status code other than 200). |
Request parameters
Name | Type | Requirement | Description |
---|---|---|---|
item | string/number | required | Product ID |
string | optionally | Email for subscription checking | |
phone | string | optionally | Phone for subscription checking |
loyalty_id | string | optionally | Loyalty ID for subscription checking |
Note |
---|
If no email, phone, or loyalty_id is specified, only the user's current device will be checked. It won't take into account subscriptions performed on the user's other devices. |
API response properties
Name | Type | Description |
---|---|---|
status | boolean | Shows whether or not there is a trigger subscription for the product |
Example of use
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("subscriptioncheck_trigger", "web_push_subscribe"product_available", {item: "100500", email: "john.doe@examplestore.com"}, function(subscibedresponse) { if (response.status) { (subscibed) console.log("Subscribed!"); } else { console.log("Not subscribed!"); } }, function(error) { // if the user has subscribed to Web Push notifications request failed. }); |
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("check_trigger", "product_available", {item: "100500"}, function(response) { if (response.status) { console.log("Subscribed!"); } else { console.log("Not subscribed!"); // if the user rejects} the Web Push notification subscription }}, function(error) { // if the request failed }); |
Subscribe to the "
Back in StockPrice Drop" trigger
Method Objective
The method subscribes the user to the notifications of a notification that the product is availableproduct price decrease.
Tip |
---|
You don't need to check for Web Push support, permission availability, or request it from the user using the methods available here. This method will do everything you need by itself. |
Syntax and parameters
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("subscribe_trigger", "product_price_availabledecrease", params); |
Name | Type | Requirement | Description |
---|---|---|---|
params | Object | required | Object with request parameters. |
Request parameters
Name | Type | Requirement | Description |
---|---|---|---|
iditem | number/string | required | The product ID to notify of the product availability price drop the user will be subscribed. |
price | number | required | The current product price. |
string | optionally | The current user's Email. If not set, the subscription will be on Web Push notification. | |
webpush | boolean | optionally | This property, if true, additionally adds the Web Push notification subscription for the specified product. |
Examples of use
Code Block | ||||
---|---|---|---|---|
| ||||
// subscribing to both channels: Email and Web Push Notifications personaclick("subscribe_trigger", "product_availableprice_decrease", { item: "100500", price: 146.55, email: "john.doe@examplestore.com", webpush: true }); |
Code Block | ||||
---|---|---|---|---|
| ||||
// subscribing to Email Notification only personaclick("subscribe_trigger", "product_price_decrease", {id item: "100500", price: 146.55, email: "john.doe@examplestore.com" }); |
Code Block | ||||
---|---|---|---|---|
| ||||
// subscribing to Web Push Notification only
personaclick("subscribe_trigger", "product_price_decrease", {
item: "100500",
price: 146.55
}); |
Unsubscribe from the "Price Drop" trigger
Method Objective
The method subscribes unsubscribes the user to a from an email notification of a product price decrease.
Syntax and parameters
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("unsubscribe_trigger", "product_price_decrease", params); |
Name | Type | Requirement | Description |
---|---|---|---|
params | Object | required | Object with request parameters. |
Request parameters
Name | Type | Requirement | Description |
---|---|---|---|
item_ids | array | required | An array of product IDs for which the user would like to unsubscribe from the price drop notification. You can use an empty array to unsubscribe from all products. |
string | required | The current user's Email. |
Examples of use
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("unsubscribe_trigger", "product_price_decrease", {
item_ids: ["100500", "146", "12"],
email: "john.doe@examplestore.com"
}); |
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("unsubscribe_trigger", "product_price_decrease", {
item_ids: [], // unsubscribe from all products
email: "john.doe@examplestore.com"
}); |
Checking the "Price Drop" trigger subscription
Method Objective
The method allows checking the subscription status of the "Price Drop" trigger.
Syntax and parameters
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("subscribecheck_trigger", "product_price_decrease", params, success, error); |
Name | Type | Requirement | Description |
---|---|---|---|
params | Object | required | Object with request parameters. |
success | Function | required | Callback-function, where the API response will be passed to. Response type: object. |
error | Function | optionally | Callback-function to be called when an error occurs (any HTTP status code other than 200). |
Request parameters
Name | Type | Requirement | Description | |||
---|---|---|---|---|---|---|
id | number/string | required | The product ID to notify of the product price drop the user will be subscribed. | |||
price | number | required | The current product price.item | string/number | required | Product ID |
string | optionally | Email for subscription checking | ||||
phone | string | optionally | Phone for subscription checking | |||
loyalty_id | string | optionally | Loyalty ID for subscription checking |
Note |
---|
If no email, phone, or loyalty_id is specified, only the user's current device will be checked. It won't take into account subscriptions performed on the user's other devices. |
API response properties
Name | Type | Description |
---|---|---|
status | boolean | Shows whether or not there is a trigger subscription for the product |
Example of use
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("subscribecheck_trigger", "product_price_decrease", {iditem: "100500", email: "john.doe@examplestore.com"}, function(response) { if (response.status) { console.log("Subscribed!"); } else { console.log("Not subscribed!"); } }, function(error) { // if the request failed. }); |
Code Block | ||||
---|---|---|---|---|
| ||||
personaclick("check_trigger", "product_price: 146.55});_decrease", {item: "100500"}, function(response) { if (response.status) { console.log("Subscribed!"); } else { console.log("Not subscribed!"); } }, function(error) { // if the request failed }); |
Column | ||||
---|---|---|---|---|
Page Navigation
|
Related Pages
|