Customizing your Embedded PerksWallet Integration
Who is this for: Developers who have completed an Embedded PerksWallet integration and want to add real-time event tracking and custom UI text.
Outcome: Configure webhook endpoints to receive offer saved and removed events, and customize CTA button labels and confirmation messages in the wallet experience.
Overview
This document outlines how to customize your Embedded PerksWallet integration with MomentScience. Customization options include CTA button labels, confirmation messages, and webhooks for tracking user actions in real time.
Note: These customization options apply to Embedded PerksWallet integrations only. If you're using Integrating with Hosted PerksWalletο»Ώ, navigate to that page to learn more about the wallet experience and available customization options.
Webhook Integration
You can configure a webhook URL to receive real-time updates about key user actions. This allows your system to track offers saved or removed as they happen, enabling better user engagement and more timely interactions.
Available Webhook Events
MomentScience will send a POST or GET request to your configured webhook URL whenever the following user actions occur:
- Offer Saved: Triggered when a user saves an offer to their wallet.
- Offer Removed from Saved: Triggered when a user removes an offer from their wallet.
You can choose whether your webhook endpoint accepts POSTor GET requests based on your system's architecture. The payload remains the same for both methods.
Webhook Payload Structure
Each event payload contains the following fields:
Field | Description |
|---|---|
event | Type of event: offer_savedor offer_removed. |
pub_user_id | Your internal user identifier. |
offer_id | Unique identifier of the offer. |
advertiser_name | Name of the advertiser. |
headline | Full headline for the offer. |
short_headline | Shortened version of the headline. |
description | Full offer description. |
short_description | Shortened offer description. |
mini_text | Supporting mini text for the offer. |
click_url | URL users are directed to when they engage with the offer. |
image | URL to the offer creative. |
cta_yes | Primary call-to-action label (e.g., "Yes Please"). |
cta_no | Secondary call-to-action label (e.g., "No Thanks"). |
tnc | Offer terms and conditions or legal disclaimer. |
timestamp | ISO 8601 timestamp when the event occurred. |
Setting Up Your Webhook
You can easily set up your webhook directly from the dashboard by following these steps:
- Navigate to the Configuration Page: Go to your account settings.
- Access Postbacks and Webhooks: Scroll down to the Postbacks and Webhooks section and click the Manage button.
- Select the Webhook Tab for PerksWallet: Navigate to the Webhook for PerksWallet tab.
- Choose HTTP Method: Select the appropriate HTTP method (either GETor POST).
- Provide the Webhook URL: Enter the URL where you want to receive the webhook notifications.
- Save the Configuration: Click the Save button to confirm your webhook settings.
- Test the Webhook (Optional): If you want to test your webhook setup, click the Test Endpoint button to send dummy data and verify the connection.
CTA Button Customization
You can customize the CTA (Call to Action) label and the confirmation message that appears after a user saves an offer. This allows you to tailor the experience to better match your productβs tone and user expectations.
Default Behavior
- CTA Button Label: "Save For Later"
- Confirmation Message: "Saved"
For both Moments Solution and Perkswall Solution, you can override these default texts through their respective integration settings.
Moments
To update the CTA text and confirmation message:
- Log in to your MomentScience Dashboard.ο»Ώ
- Navigate to the Moments Integration Page.
- Select the Theme Settings tab.
- Make sure that "Show PerksWallet CTA" is enabled.
- Scroll to the field labeled PerksWallet CTA.
- Update the CTA button label (e.g., change "Save For Later" to "Add to Wallet").
- Below that, update the Saved Offer Text field.
- This text appears after the user clicks the button (e.g., change "Saved" to "Offer Added to Wallet").
Perkswall
To update the CTA text and confirmation message:
- Log in to your MomentScience Dashboard.ο»Ώ
- Navigate to the Perkswall Integration Page.
- Select the Theme Settings tab.
- Make sure that "Show PerksWallet CTA" is enabled.
- Scroll to the field labeled PerksWallet CTA Text.
- Update the CTA button label (e.g., change "Save For Later" to "Add to Wallet").
- Below that, update the Saved Offer Text field.
- This text appears after the user clicks the button (e.g., change "Saved" to "Offer Added to Wallet").
π’ If you're running into any issues while going through the integration process, feel free to contact us at [email protected]ο»Ώ