Get and Update Project Settings
The getAndUpdateProjectSettings() API is responsible for retrieving the latest project configuration from the PageSense servers and updating the SDK’s internal state accordingly. This ensures that your application always operates with the most recent experiment rules, variation details, targeting criteria, and other project-level updates defined in the PageSense dashboard.
The API can be triggered through one of the following mechanisms:
Webhook-based updates – Project settings are refreshed automatically when PageSense sends a webhook notification.
Polling-based updates – The SDK periodically checks for configuration changes using a scheduled background thread.
Both mechanisms serve the same purpose—keeping the SDK synchronized with PageSense—but differ in how and when the updates are initiated.
Webhook-Based Updates
When changes are made to an experiment in PageSense—such as editing variations, updating conditions, or adjusting goals—the experiment is typically paused, modified, and then relaunched. If you have configured a webhook endpoint in your PageSense project’s Environment Settings, PageSense sends an outbound webhook request to your server each time an experiment is relaunched.
Your server should be prepared to:
Receive the webhook request from PageSense, and
Invoke the getAndUpdateProjectSettings API immediately after receiving the notification.
This ensures that the SDK refreshes its configuration without waiting for the next polling cycle, allowing users to receive the updated logic almost instantly.
Webhook Retry Behavior
Polling-Based Updates
If webhook integration is not suitable for your infrastructure, the SDK supports a polling mechanism as an alternative approach. Polling enables the SDK to periodically check PageSense for configuration updates at intervals defined during initialization.
Once polling is enabled:
The SDK starts a background polling thread.
At each interval, the SDK calls getAndUpdateProjectSettings.
If updates are detected, the SDK refreshes its internal project state.
If no updates are found, the SDK continues using the existing configuration until the next cycle.
Polling provides a predictable and dependable way to keep project settings current, especially in environments where webhooks cannot be received due to firewall restrictions, network policies, or server limitations.
Calling the Method
- $pageSenseClient->getAndUpdateProjectSettings($accountName, $sdkKey, $projectName);
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. |
Choosing Between Webhooks and Polling
Method | Best For | Characteristics |
Webhook | Real-time updates | Fastest way to sync settings; ideal for dynamic or frequently updated experiments. |
Polling | Environments without webhook capabilities | SDK checks for updates on a schedule; reliable fallback when webhooks are not feasible. |
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:
Create. Review. Publish.
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.
Zoho Sheet Resources
Zoho Forms Resources
Zoho Sign Resources
Sign, Paperless!
Zoho TeamInbox Resources
Design. Discuss. Deliver.
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 ...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 ...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: ...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 ...