NUTRINTG fromSHPF Config
- Sebastian Baltruszewicz
How to integrate Shopify store with CDP
Webhooks send required data to CDP Middleware after the appropriate event occurred, for example, customer created account.
- Go to the Notification settings page of the Shopify store:
[name specific to this store].myshopify.com/admin/settings/notifications E.g. scholluk.myshopify.com/admin/settings/notifications - Go to the Webhooks section at the bottom of the page
- Create 3 webhooks according to table Requirements:
- Click "Create webhook" button
- Choose "Event" type
- Choose "Format" type
- Provide "URL"
- Choose "Webhook API version"
| REQUIREMENTS | |||
| Event | Format | URL | Webhook API version |
|---|---|---|---|
Customer creation | JSON | https://api.cdp-rb.com/shopify/customer | 2019-04 |
Customer update | JSON | https://api.cdp-rb.com/shopify/customer | 2019-04 |
Order creation | JSON | https://api.cdp-rb.com/shopify/order | 2019-04 |
Provide below properties to Product Analyst of CDP Middleware:
- URL of the notification settings page of Shopify store, e.g. scholluk.myshopify.com/admin/settings/notifications
- Brand of the store, e.g. Dettol
Properties of LDS documents accepted by customer (Privacy Policy, Terms and Conditions):
BusinessId, RevisionId, ConsentAcceptedInd, ConsentDesc, MandatoryInd, CustomName, AgreementDateHMAC (provided at the bottom of Notifications Settings page). For security reasons add value in the online sheet HMAC SHPF in green color (so that we knew it's new value).
Credentials will enable CDP Middleware to send requests to this store in order to fetch data of Abandoned checkout and more.
- Go to the "Manage Private Apps" page:
[name specific to this store].myshopify.com/admin/apps/private/ E.g. scholluk.myshopify.com/admin/apps/private/ - Click Create a new private app.
- Set below properties
Private app name: CDP Middleware [today's date] E.g. CDP Middleware 29.07.2019
Emergency developer email: [CDP Middleware Software Team Leader] At the moment: Kostiantyn.Ivanov@rb.com
Permissions: Products, variants and collections - read access. Rest of the items should be set to "No access" for security reasons.
Webhook API version: 2019-07
and click Save. After page is refreshed, copy API key and Password and send in separate emails to CDP Middleware Software Team Leader.
Instruction for Middleware team
New store rollout checklist
- Send request Epsilon to add account source codes and data source code
- Add HMAC and store URL to the HMAC list in order to pass validation byt its webhook
- Add store URL to Shopify URL Mapping.xlsx (by editing the file with Atlassian plugin - screenshot below) and its equivalent in the Mulesoft config. As we accept webhooks only from predefined URL's.
We had talked about a direct API for you to set up some of the metadata. So as it stands today this is what would have to happen for a new country/site:
1. RB inform Epsilon of the new country/site that will be upcoming
2. Epsilon sets up the appropriate brand_org_code, acct_src_Code, data_source_code, and data retention metadata
3. Epsilon maps the appropriate subscriptions to the sites
4. If this is a new country we have not brought in before we will need to get data in advance to do a DQA to see if there are any Agility Connect adjustments like we saw with Germany.
5. We would have to schedule the initial load coordinated with timing for the go-live.
6. Run the initial load test in UAT to confirm as well as a test UAT connection from the site via the API/middleware
7. Coordinate the production initial load and turn on the web site for production.
For adding new forms for an already converted site:
1. Epsilon would just to need to learn what the data source and expiry date is for the new form and add it to the metadata prior to the web site communicating data for the form.