Get and Update Project Settings
Overview
The getAndUpdateProjectSettings API is used to fetch the latest project setting details from the PageSense server and update the SDK accordingly. This ensures your application remains fully synchronised with any updates made in the PageSense application, including changes to experiments, variations, targeting conditions, and other project-level settings. This API can be invoked in two ways: Webhook or Polling.
- Webhook-based integration: This updates the project settings asynchronously based on event triggers from PageSense.
- Polling-based integration: This updates the project settings synchronously at a predefined time interval using a dedicated polling thread in SDK.
Webhook
When users make updates to a FullStack A/B experiment in PageSense—such as editing variations, changing targeting conditions, or modifying goals—they usually pause the experiment, apply the required changes, and then relaunch it by clicking the Launch button.
If a webhook has been configured in the Environment Settings of your PageSense project, PageSense will automatically trigger a webhook call to the specified webhook endpoint whenever the experiment is relaunched.
Your system should be prepared to receive the webhook call from PageSense and trigger the getAndUpdateProjectSettings API immediately after receiving the webhook, so the API updates the latest project setting details in the without any delay.
Webhook Retry
If the initial webhook call fails due to network issues or server downtime, PageSense will automatically retry the webhook call every 30 seconds for up to 15 minutes. If the call is not successfully processed within that time window, retries will stop. However, if additional updates are made and the experiment is relaunched, the webhook call will be retried again.
Polling
If webhook integration is not feasible in your environment, you can use the SDK’s polling mechanism to keep the project setting details up to date. When polling is enabled, the SDK automatically calls the getAndUpdateProjectSettings API at regular intervals (configured by you) to check for any updates in PageSense.
A background thread in the SDK is started for the polling based on the configured polling interval. At each interval, it calls the getAndUpdateProjectSettings API to check for updates in the PageSense project settings. If any changes are detected, the API updates the internal state of the SDK with the latest project setting details. If there are no changes, the SDK runs with the existing project settings until the next polling cycle.
Polling is a reliable fallback if webhook support is unavailable or impractical in your server architecture.
API Usage
- pageSenseClient.getAndUpdateProjectSettings("accountName", "sdkKey", "projectName");
Parameter details:
Parameter | Type | Required | Description |
accountName | String | Yes | The unique identifier of your PageSense account. |
sdkKey | String | Yes | The secure key for the environment, available under the Environment section of the PageSense application. |
projectName | String | Yes | The name of the project as defined in your PageSense account. |
Example code
- pageSenseClient.getAndUpdateProjectSettings("ZylkerUser1", "xyz123abdscd", "ZylkerFullStackProject");
We hope this documentation helps make the process easy for you. Please feel free to reach out to us anytime by dropping an email to support@zohopagesense.com if you need more explanation or have any questions.
Access your files securely from anywhere
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho Writer?
Create. Review. Publish.
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Get and Update Project Settings
Overview The getAndUpdateProjectSettings API is used to fetch the latest project setting details from the PageSense server and update the SDK accordingly. This ensures your application remains fully synchronised with any updates made in the PageSense ...Configure your pop-up settings
The success of any pop-up depends on delivering it at the right time on the right page based on customers' interactions or actions carried out on your website. With PageSense, you can choose the web pages where you want to show your pop-up, and ...Get started with your PageSense Mobile Push Notifications
Building and maintaining an efficient relationship with your user group is crucial and mobile push notifications are spot-on the most effective way. From interacting with your consumers, boosting conversions, and improving user experience—it’s a ...Get Variation Name
The Get Variation Name API is used to return the name of a FullStack A/B Test experiment. It evaluates whether the user qualifies for the experiment and assigns a variation accordingly. Using getVariationName without user attributes Method string ...Get Variation Name
The getVariationName API is used to get the allocated variation for the user for the specified FullStack A/B Test experiment. Method: String variationName = pageSenseClient.getVariationName(experimentName, userId, userAttributes); Parameters: ...
New to Zoho LandingPage?
Zoho LandingPage Resources