-
Couldn't load subscription status.
- Fork 81
IBX-5644 - Email triggers #2022
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
f0774b0
6740adc
86b9009
8a04bdb
09aad8c
b5f036c
38a110c
dc3271f
c61a0e8
5112f9b
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -151,6 +151,62 @@ if ($recommendations && isset($recommendations->recommendationResponseList)) { | |
| curl_close($curl); | ||
| ``` | ||
|
|
||
| ## Send emails with recommendations | ||
|
|
||
| By using [email triggers]([[= user_doc =]]/personalization/triggers.md), your organization can send emails to individual visitors, for example, to invite them to return to the website or remind them of items abandoned in a cart. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The link is broken. Only visitors? Clients, customers too. I would change the order in the sentence to more active and calling users to action. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Agreed re. order, while "client" and "customers" are used in a different meaning throughout perso: |
||
|
|
||
| Email triggers are push messages with recommendations. | ||
| Specific conditions, such as the time that must pass before email start being sent, content types and attributes to be included in a response, or a number of repetitions, are first defined based on an interview between you and Ibexa. | ||
dabrt marked this conversation as resolved.
Show resolved
Hide resolved
dabrt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| Email triggers are then processed on the Personalization server and responses are delivered to a dedicated endpoint. | ||
|
|
||
| To let your visitors receive emails with recommendations: | ||
|
|
||
| 1\. With the [User API](api_reference/user_api.md#post-requests), add the `e-mail` attribute (or another identifier) to the user record. | ||
|
|
||
| 2\. Prepare an endpoint to intercept push messages and pass them on, for example, to your mailing system. | ||
| Out of many options, it could be an Ibexa Connect [webhook](https://doc.ibexa.co/projects/connect/en/latest/tools/webhooks/). | ||
| The endpoint must meet the following requirements: | ||
|
|
||
| - must support POST requests | ||
| - must accept JSON objects in a format that resembles the following example: | ||
dabrt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ``` json | ||
| { | ||
| "customerID":"1234567", | ||
| "userExternalId":"user@domain.com", | ||
| "triggerType":"REACTIVATION|ABANDONED_SHOPPING_CART", | ||
| "triggerName":"TRIGGER_REF_CODE", | ||
| "triggerOpenedLink":"NEW_EVENT_FOR_TRIGGER_OPENED", | ||
| "recommendations":[ | ||
| { | ||
| "itemId":959, | ||
| "itemType":46, | ||
| "links":{ | ||
| "clickRecommended":"CLICK_RECOMMENDED_LINK_WITH_TRIGGER_REF_CODE", | ||
| "rendered":"RENDERED_LINK" | ||
| }, | ||
| "attributes":{ | ||
| "ses_name":"First product's name", | ||
| "ses_image":["img_1", "img_2"] | ||
| } | ||
| }, | ||
| { | ||
| "itemId":123, | ||
| "itemType":55, | ||
| "links":{ | ||
| "clickRecommended":"CLICK_RECOMMENDED_LINK_WITH_TRIGGER_REF_CODE", | ||
| "rendered":"RENDERED_LINK" | ||
| }, | ||
| "attributes":{ | ||
| "ses_name_for_type_55":"Second product's name" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| 3\. Contact `support@ibexa.co` with your organization's requirements to have the email triggers enabled. | ||
|
|
||
| ## Advanced integration | ||
|
|
||
| You can configure integration at a more advanced level to track more events, | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.