Encourage your customers to share your content on social media. Within the Social Share Campaigns module, you can define campaign criteria that determine which types of shares may qualify for rewards.
To enable tracking, your developer needs to place share buttons on the relevant content pages. These buttons should open the social platform’s share window and send a request to Antavo’s /v1/social-share-campaign/share-intent
endpoint when clicked. Based on the data in this request, the system checks whether the action meets the criteria of any active social share Campaign. If it does, the share_intent_success
customer event is added, indicating that the participation is recorded and the customer may become eligible for a reward.
Please note that Antavo cannot verify whether the customer completed the share after opening the share window. The system evaluates only the received share-intent requests against the campaign criteria.
While the module tracks participation and validates share-intent requests, it does not itself grant rewards or other benefits. All benefits, such as rewards, points, or coupons, should be allocated through workflows, giving you full flexibility in defining and managing the incentives.
To access the configuration page of the module, navigate to the Modules menu and search for the Social Share Campaigns module. The page will display the list of campaigns configured within the module, along with the following details:
Priority | Priority defines the evaluation order when a share-intent matches multiple campaigns. Lower numbers indicate higher priority. |
Name | The name of the campaign |
Platforms | The list of social media platforms where customers should share the content |
Creating a new campaign
To create a new campaign, click the Create new contest button in the sidebar of the Contest lite module page or click the Create button in the top-right corner.
Basic information
Enter the name of the campaign
This is for administrative purposes only and is visible only in the Management UI.Write the description of the contest
Also for administrative purposes only and displayed only in the Management UI.Enter the social media platforms on which customers are expected to share the content.
Facebook and X are available by default, but you can add any other platforms by typing their name. An entry will qualify for the campaign if the system detects (based on a request sent to the/v1/social-share-campaign/share-intent
endpoint) that the customer shared the content to one of the platforms you have listed here.Add the URL of the page(s) that customers should share
You can set multiple URLs. The system will check the link that the customer shared and see if it matches any of these, including subpages. For example, if you add brand.com, sharing brand.com/summer-collection will also count as a valid campaign entry.Enter the maximum number of shares that can be counted as valid participations for a single customer in this campaign.
If a customer shares more than this number, only the first shares up to the limit will be registered as participation.
Schedule
Define when customers can participate in your campaign using the Starts At and Ends At fields. Dates must be entered in UTC, but the system will display the equivalent time in your workspace’s local timezone for reference. Only shares made within this time window will be registered as campaign participation.
If the fields are left empty, there is no time window and customers can participate at any time.
Save your settings
Click Create to save the campaign. It will be created with Draft status.
Manage campaign priority
Before activating your campaign, it’s recommended to set its priority relative to your other campaigns. When a share matches the criteria of a higher-priority campaign, it will be registered as a success for that campaign only, and lower-priority campaigns will not be checked.
We recommend arranging campaigns from the most specific to the most general because this ensures that targeted campaigns capture the relevant shares first.
You can adjust priorities easily by dragging and dropping campaigns on the Manage Campaigns page.
For example:
A campaign targeting brand.com/summer-collection/sungdresses
B campaign targeting brand.com/summer-collection
If a customer shares a page under brand.com/summer-collection/sundresses, it will count for the more specific campaign first.
If the order were reversed (general first, specific later), the general campaign would register the share before the specific campaign is checked. As a result, the more specific campaign might never get credit for relevant shares, which can lead to less meaningful campaign data and rewards being attributed less thoughtfully.
Activating the campaign
When you save a new campaign for the first time, it is created in Draft status.
To activate the campaign, click the Set Active button in the top-right corner of the setup page, and confirm the activation in the dialog that appears. Once activated, the campaign can start registering eligible share intent requests according to its configured participation criteria and schedule.
Rewarding shares
When a share intent request matches an eligible campaign, the system records a share_intent_success
event in the customer’s event history. This event indicates a successful participation in a campaign.
The Social share campaigns module itself does not assign points or rewards. Using the Workflow module, you can leverage this event as a trigger to deliver any loyalty benefit to the customer. You can filter by campaign ID and grant rewards such as a configured reward, coupon, or loyalty point, or any other reward mechanism that fits the concept of your loyalty program.
Example workflow setup:
This example shows how different loyalty benefits can be allocated based on participation in different campaigns.
Inbound logs
The Inbound Logs let you review all share intent requests sent to the /v1/social-share-campaigns/share-intent
endpoint. Each entry indicates which customer attempted to participate, when, and whether their participation met any campaign’s participation criteria.
For each request, you can track details such as the campaign it applied to (if eligible), the response status, a unique log ID, and any errors. Each log entry can be expanded to see the entire request sent. Use the search bar to filter logs based on these details.
Logs are stored for 90 days and then automatically archived.
Completed challenges
Once a campaign has passed its End Date or has been manually set to Completed, it moves to the Completed Campaigns page. Here you can browse past campaigns for reference and view campaign details.
A completed campaign will no longer register participation and cannot be reactivated. It serves as a historical record of campaigns that have ended.
Managing campaigns
Edit a campaign
Only campaigns in draft status can be edited. Once a campaign is activated, its configuration can no longer be modified.
Navigate to the Manage Campaigns tab
Click the Edit button of the campaign you want to edit
Make the necessary changes
Click Update to save your changes
Close a campaign
You can close a campaign before the end date if you want to stop it from accepting further participation.
Navigate to the Manage Campaigns tab
Click the Edit button of the campaign you want to set complete
Click the Set complete button
Confirm your choice in the dialog that appears
Closing a campaign is irreversible. Once closed, the campaign cannot be edited or reactivated. Any participations already registered remain in the system, but no new share intents will be accepted.
Deactivate a contest
If you want to temporarily stop a campaign without closing it:
Navigate to the Manage Campaigns tab
Click the Edit button of the campaign you want to deactivate
Click the Set inactive button in the upper right-hand corner of the page
Confirm your choice in the dialog that appears
Deactivated campaigns can be reactivated later. Unlike closing, deactivation is reversible.
Clone a campaign
You can clone an active, inactive, or closed campaign to create a new campaign with the same setup. Cloning is useful to quickly create a similar campaign without re-entering all settings.
Navigate to the Manage Campaigns tab (for active and inactive campaigns) or the Completed Campaigns tab (for completed campaigns)
Click the View button of the campaign you want to clone
Click the Clone button in the upper right-hand corner
You’ll be redirected to the Create Campaign page with the platform, URL, and max share settings pre-populated from the original campaign
Archive a contest
Archiving permanently removes a campaign from the system. Use this for inactive or closed campaigns you no longer need.
Navigate to the Manage Campaigns tab (for inactive campaigns) or the Completed Campaigns tab (for completed campaigns)
Click the Edit or View button of the inactive contest you want to archive
Click the Archive button in the upper right-hand corner of the page
Confirm your choice in the dialog that appears
Archiving is irreversible. Once archived, a campaign cannot be restored. Closed campaigns will also disappear from the list of completed campaigns.