Zephr

https://docs.zuora.com/en/zephr
Admin
Zephr is a digital subscription platform that optimizes customer journeys and boosts revenue growth...
Tokens:132,402
Snippets:1,870
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Extract and Navigate to BigQuery Setup Example

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/bigquery

Unzip the provided archive and navigate into the extracted directory to begin setting up your BigQuery environment.

```bash
$ unzip zephr-bigquery-setup-example.zip
$ cd zephr-bigquery-setup-example
```

--------------------------------

### Get Shared Products Summary

Source: https://docs.zuora.com/en/zephr/faq-and-examples/customer-journey-examples/offer-shareable-products/example-customer-pages

Use this GET command to retrieve a summary of products that a customer has shared. Refer to the API documentation for schema details, example headers, and body content.

```bash
GET /zephr/public/products/v1/shares
```

--------------------------------

### Make BigQuery Setup Script Executable

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/bigquery

Grant execute permissions to the BigQuery setup script before running it.

```bash
$ chmod +x sample-bigquery-setup-script.sh
```

--------------------------------

### Example Dynamic Offer Response

Source: https://docs.zuora.com/en/zephr/configure-products/dynamic-offers/api-examples-for-dynamic-offers

This JSON snippet shows an example response structure for a dynamic offer, detailing various configuration parameters for charges and discounts.

```json
{
  "isPrepaid": false, 
  "isRollover": false, 
  "isStackedDiscount": false, 
  "isUnbilled": false, 
  "legacyRevenueReporting": false, 
  "listPriceBase": "Per Billing Period", 
  "name": "discount", 
  "numberOfPeriod": 1, 
  "overageCalculationOption": "EndOfSmoothingPeriod", 
  "overageUnusedUnitsCreditOption": "NoCredit", 
  "priceChangeOption": "NoChange", 
  "priceIncreasePercentage": 0.0, 
  "priceUpsellQuantityStacked": false, 
  "productRatePlanChargeNumber": "PRPC-00000011", 
  "productRatePlanId": "ee61dac068f94b67d424d5db0af800db", 
  "rolloverApply": "ApplyLast", 
  "rolloverPeriodLength": 0, 
  "rolloverPeriods": 0, 
  "taxable": false, 
  "triggerEvent": "ContractEffective", 
  "upToPeriods": 1, 
  "upToPeriodsType": "Billing Periods", 
  "useDiscountSpecificAccountingCode": false, 
  "useTenantDefaultForPriceChange": false 
}, 
"chargeDefinitionData": {
  "effectiveEndDate": "2026-02-05T00:00:00Z", 
  "overageUnusedUnitsCreditOption": "NoCredit", 
  "productRatePlanChargeId": "ee61dac069a94b67d424d5dcca080009", 
  "discountLevel": "rateplan", 
  "excludeItemBillingFromRevenueAccounting": false, 
  "productChargeDefinitionId": "ee61dac069a94b67d424d5dcca080009", 
  "legacyRevenueReporting": false, 
  "overageCalculationOption": "EndOfSmoothingPeriod", 
  "description": "", 
  "isUnbilled": false, 
  "useDiscountSpecificAccountingCode": false, 
  "isPrepaid": false, 
  "rolloverPeriodLength": 0, 
  "priceChangeOption": "NoChange", 
  "effectiveStartDate": "2025-02-05T00:00:00Z", 
  "isRollover": false, 
  "upToPeriodsType": "Billing Periods", 
  "listPriceBase": "Per Billing Period", 
  "isStackedDiscount": false, 
  "productChargeDefinitionNumber": "CD-00000021", 
  "rolloverPeriods": 0, 
  "taxable": false, 
  "billingPeriod": "Month", 
  "excludeItemBookingFromRevenueAccounting": false, 
  "billCycleType": "DefaultFromCustomer", 
  "applyToBillingPeriodPartially": false, 
  "productChargeId": "ee61dac069a94b67d424d5dcca080009", 
  "priceIncreasePercentage": 0.0, 
  "billingPeriodAlignment": "AlignToCharge", 
  "productRatePlanChargeNumber": "PRPC-00000011", 
  "defaultQuantity": 0.0, 
  "isCommitted": false, 
  "rolloverApply": "ApplyLast", 
  "useTenantDefaultForPriceChange": false, 
  "applyDiscountTo": "RECURRING", 
  "chargeModel": "Discount-Percentage", 
  "numberOfPeriod": 1, 
  "endDateCondition": "FixedPeriod", 
  "priceUpsellQuantityStacked": false, 
  "triggerEvent": "ContractEffective", 
  "isAllocationEligible": false, 
  "upToPeriods": 1 
},
"discounts": [ ] 
}
]
}
]
```

--------------------------------

### Buy Product Webhook Example (Salesforce to Zephr)

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/salesforce/integrating-zephr-within-salesforce

Use this webhook to grant a product to a Zephr user when a product or subscription is added to their Salesforce Contact. It supports single product IDs, multiple product IDs, or a list of products with specified start and end times.

```http
Content-Type: application/json POST: /plugins/salesforce/webhooks?event=buyProduct&code=bf6414ce-1221-4a90-a9f2-975c67288abe
```

--------------------------------

### Example of Displaying a User Variable

Source: https://docs.zuora.com/en/zephr/configure-products/rules-builder/feature-outcomes/custom-component-blocks/user-variables-in-custom-components

This example shows how a user variable for a first name would be displayed for a registered user. It demonstrates the practical application of the variable format.

```text
Gwen
```

--------------------------------

### Example Product Mapping Configuration

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/cds

An example illustrating how to map a specific CDS prodId (ABC) to Zephr Product IDs using various special product codes, including single and array assignments.

```json
{ "ABC": { "X": "my-zephr-product-1", "Y": "my-zephr-product-2", "Z": [ "my-zephr-product-1", "my-zephr-product-2" ] } }
```

--------------------------------

### Example Request URLs (Origin as Destination)

Source: https://docs.zuora.com/en/zephr/integration/integration-methods/browser-side-html-features/integrate-in-existing-technology-stack/cross-domain-cookies-in-javascript-deployments/optimized-process

When using the optimized process, API calls are made using the Origin as the destination. This example shows the format of such request URLs.

```plaintext
https://latestnews.cdn.arcpublishing.../zephr/feature
https://latestnews.cdn.arcpublishing...ture-decisions
```

--------------------------------

### Example PBKDF2 Hash String

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/login-extension

This is an example of a PBKDF2 hash string, showing how data segments are typically delimited by a '$' character. Note that the characters in this example do not represent a valid hash.

```text
pbkdf2_sha256$10000$WtfwHgrhdWFb$HbQyTOwl/hxjb9I10OMj+Efb6zhwgOnsYoKLfeLjCf3g=
```

--------------------------------

### Example cURL Request for Dynamic Offers

Source: https://docs.zuora.com/en/zephr/configure-products/dynamic-offers/create-dynamic-offers

This is an example cURL request that can be used to preview dynamic offers. It demonstrates the structure of a request to the Zephr API.

```bash
curl -X POST \
  'https://your-api-domain.com/v1/offers/your-offer-id/preview' \
  -H 'Content-Type: application/json' \
  -d '{ "inputs": { "your-input-key": "your-input-value" } }'
```

--------------------------------

### Marking HTML Content with Zephr Feature Tags

Source: https://docs.zuora.com/en/zephr/configure-products/features/add-a-feature/configure-html-features-in-the-developer-interface/use-comment-tags-to-mark-html-features

This example demonstrates how to wrap an HTML article body with Zephr comment tags to control feature access. The <!-- ZEPHR_FEATURE --> and <!-- ZEPHR_FEATURE_END --> tags identify the start and end of the featureable content.

```html
<head>… </head>
<body>
<h1>A site!</h1>
<nav>… </nav>
<div class="page-wrapper">
<h2>Something interesting</h2>
<!-- ZEPHR_FEATURE article-body -->
<article class="article-body">
<p>…</p>
<img>
<p>…</p>
</article>
<!-- ZEPHR_FEATURE_END article-body -->
<ul class="related-reading">… </ul>
</div>
</body>
```

--------------------------------

### Initiate OpenWeb SSO Flow

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/openweb-single-sign-on-sso

This JavaScript code snippet demonstrates how to initiate the OpenWeb SSO flow. It includes a callback function to handle the `code_a` from the SPOTIM module, fetch `code_b` from your backend, and complete the SSO process. Ensure the user is logged into your site before initiating this function. The `credentials: 'include'` setting is important when using the Zephr CDN.

```javascript
<div data-spotim-module="pitc"></div><script async data-spotim-module="spotim-launcher" src="https://launcher.spot.im/spot/{{spot-id}}" data-post-id="12345"></script> <script> if (window.SPOTIM && window.SPOTIM.startSSO) { startSSO(); } else { document.addEventListener('spot-im-api-ready', startSSO, false); } // Prior to initiating this function, ensure that the user // is actively logged into your site function startSSO() { var callback = function(codeA, completeSSOCallback) { // call your backend to receive codeB and return it // to OpenWeb via completeSSOCallback function fetch('{{base-url}}/plugins/public/openweb-v2/sso', { method: 'POST', headers: { 'Content-Type': 'application/json' }, body: JSON.stringify({ code_a: codeA, }), credentials: 'include' }).then(res => res.json()).then(res => { if(res.codeB){ completeSSOCallback(res.codeB) } }); }; window.SPOTIM.startSSO(callback).then(function(userData) { console.log(userData) }).catch(function(reason) { console.error(reason) }); } </script>
```

--------------------------------

### Example Transformations Data

Source: https://docs.zuora.com/en/zephr/configure-products/features/add-a-feature/configure-sdk-features-in-developer-interface/sdk-output-types

This example shows the structure of the returned transformations data when an SDK feature rule is triggered, including custom components and forms.

```json
"transformations":[ { "transformType":"CUSTOM_COMPONENT", "resourceId":"7fb6c2d1-a894-4450-a791-34e6eab1ea13", "contentPath":"/zephr/public/ui-components/v1/ui-components/7fb6c2d1-a894-4450-a791-34e6eab1ea13" },{ "transformType":"FORM", "resourceId":"M-2EZg3K", "contentPath":"/zephr/public/ui-components/v1/ui-components/M-2EZg3K" },{ "transformType":"FORM", "resourceId":"F-lEWwDb", "contentPath":"/zephr/public/ui-components/v1/ui-components/F-lEWwDb" }]
```

--------------------------------

### Import User with MD5 Legacy Password

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/login-extension

Use this example to import a user with MD5 legacy password credentials. The `legacy_password` field must contain a stringified JSON object with algorithm, hash, and salt details.

```json
{ "identifiers": { "email_address": "bob.smith@example.com" }, "validators": { "legacy_password": "{\"algorithm\": \"md5\",\"hash\": \"cc58db7c46ddbee969c257af0c505498\", \"salt\": \"mySuperSecureHash\"}" }, "attributes": { "first-name": "Bob", "last-name": "Smith" } }
```

--------------------------------

### Configure JSON Output with Schema

Source: https://docs.zuora.com/en/zephr/configure-products/features/add-a-feature/configure-sdk-features-in-developer-interface

Illustrates how to configure a 'JSON' output type and optionally provide a JSON schema for validation.

```text
If you select JSON, you can provide a JSON schema after turning on the Validate with JSON Schema option, as illustrated below:
```

--------------------------------

### User Attribute Mapping Configuration Example

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/extended-profile---user-attribute-mapper

Example of how to configure mappings between Extended Profile properties and Zeph User Attributes. Ensure data types match.

```json
{ "ext-prof-first-name": "firstName", "ext-prof-last-name": "familyName", "ext-prof-profession": "user-details.employment.job-title", "ext-prof-company": "user-details.employment.employer", "ext-prof-mailing-list-consent": "content_prefs.email" }
```

--------------------------------

### Configure Permutive SDK in HTML Head

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/extensions/permutive

Add this script block to the `<HEAD>` of your HTML pages to initialize the Permutive SDK. Replace placeholders with your actual Permutive project ID and web API key. Ensure script injection is enabled if using the Zephr Zephr CDN.

```html
<!-- start Permutive --> <script>!function(n,e,o,r,i){if(!e){e=e||{},window.permutive=e,e.q=[],e.config=i||{},e.config.projectId=o,e.config.apiKey=r,e.config.environment=e.config.environment||"production";for(var t=["addon","identify","track","trigger","query","segment","segments","ready","on","once","user","consent"],c=0;c<t.length;c++){var f=t[c];e[f]=function(n){return function(){var o=Array.prototype.slice.call(arguments,0);e.q.push({functionName:n,arguments:o})}}(f)}}}(document,window.permutive,"<PERMUTIVE_PROJECT_ID>","<PERMUTIVE_WEB_API_KEY>",{});permutive.addon('web', {}); </script> <script async src="https://cdn.permutive.com/<PERMUTIVE_PROJECT_ID>-web.js"></script> <!-- end Permutive -->
```

--------------------------------

### Example Product Rule Output

Source: https://docs.zuora.com/en/zephr/configure-products/dynamic-offers/product-property-overview

This JSON structure represents the product information returned when a dynamic offer rule is triggered. It includes product IDs, labels, descriptions, features, and custom properties.

```json
{
  "products": [
    {
      "id": "observe-basic",
      "label": "Observe Basic",
      "description": "",
      "features": [
        {
          "id": "automatic-data-capture",
          "label": "Automatic data capture",
          "description": " ",
          "type": "SDK"
        }
      ],
      "sharingLimit": 0,
      "metadata": {
        "order": 1,
        "recommended": false
      },
      "prices": [],
      "properties": {
        "session-limit": 1000
      }
    }
  ]
}
```

--------------------------------

### Rule Outcome Webhook Payload Example

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/webhooks/system-webhooks

This is an example of the JSON payload sent when the Rule Outcome webhook is triggered. It includes details about the tenant, session, user, and rule outcomes.

```json
{ "tenantId": "testtenant", "subTenantId": "testtenant|demo", "type": "RULE_OUTCOME", "time": 1682328910202, "details": { "userId": "aaa0124c-c665-4368-ab24-554e7fd0e6f7", "sessionId": "aaa0124c-c665-4368-ab24-554e7fd0e6f7", "trackingId": "b009cbd3-f07b-4675-9f46-d8101938b995", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/109.0", "uri": "http://jamesleach-demo.cdn.zephr.com/2013/01/01/threaded-comments/", "country": "IE", "state": "Leinster", "city": "Dublin", "outcomes": [ { "ruleId": "H-article-140", "outcomeId": "graph/1#2,graph/1#3,graph/1#5,graph/2#1,graph/2#2,transformation/4", "outcomeLabel": "sf" } ] }, "webhook": "rule outcome" }
```

--------------------------------

### Initialize Zephr Browser Module via NPM

Source: https://docs.zuora.com/en/zephr/configuration--integrations/integration-methods/browser-side-html-features/integrate-in-existing-technology-stack/install-a-standalone-website

This JavaScript code demonstrates how to import and initialize the Zephr browser module after installing it via NPM. Ensure the `baseUrl` is correctly set to your site's default URL.

```javascript
import * as zephrBrowser from 'zephr-browser.modern.js';
document.addEventListener('DOMContentLoaded', (event) => {
  zephrBrowser.run(baseUrl);
});
```

--------------------------------

### Example JWT Payload for Product Syncing

Source: https://docs.zuora.com/en/zephr/configuration--integrations/settings/json-web-tokens-jwt/enabling-product-syncing-with-jwt

This is an example of a JWT payload that includes a product subscription and first-party data. It demonstrates how product grants and other user attributes can be represented in the token.

```json
{
  "prodsub": ["subscription-a"],
  "city": "NY"
}
```
Tokens:
Raw