Documentation Index
Fetch the complete documentation index at: https://docs.withbenji.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
The campaigns page provides a list view of all the currently configured campaigns under a specific partnership. Each campaign line item on the homepage shows you the following information:| Parameter | Description | Possible values |
|---|---|---|
| ID | The unique system-generated identifier for this campaign. This identifier will be used by the integrating partner when calling the Benji API to interact with the campaign. | A system-generated number |
| Campaign Name | This field shows 2 values: The type of campaign and the descriptive name assigned to this field. | For campaign type: Earn Redeem Transfer Connect Only |
| Trigger | The trigger action associated with this campaign. | Spend per Dollar - for campaigns triggered by a user transaction Registration - for campaigns triggered by a user registration Customer Referral - for a campaign triggered by a user referring another user to the partner Custom Action - An action not supported natively by Benji. The partner will own the placement and rendering of the components for these action triggers |
| Conditions and Multipliers | All of the conditions and multipliers configured under this campaign | |
| Status | The running status of the Campaign | Active - a campaign that is currently live Scheduled - a campaign scheduled for a future date Draft - a campaign that has not yet been approved. |
| Actions | A list of actions to perform on the specific campaign | Edit - will open up the campaign edit modal Duplicate - duplicates this campaign with all of its settings to a new campaign in Draft mode Approve - initiates the campaign approval flow Delete - will popup a confirmation modal to approve deletion of this campaign. |
Navigation
The campaigns page is accessed by clicking on a partnership tile on the Partnerships Homepage. The campaigns page supports the following navigation/actions on the top header:- Switching between Campaigns and Partner details. The partner details section will display read-only basic information about the given partner.
- CTA to import campaign: Allows you to upload a campaign configuration from an XLSX template
- New campaign: Opens the new/edit campaign modal
Campaign Templates
Campaign templates streamline campaign creation by letting you reuse configurations across multiple partnerships and save time on setup.- Create campaigns using templates and customize. When creating a new campaign, click “Import Campaign” to use an existing template that will prepopulate all your campaign settings based on the template configuration. You can modify any settings before saving the campaign to match your specific requirements.
- Turn existing campaigns into reusable templates. After creating a campaign, you can convert it into a template by clicking the “Actions” menu on the campaigns page for that campaign and selecting “Create Template”. This template becomes available for use with any partner.
- Access all your templates in one place. View and manage all campaign templates by navigating to “Partner Settings” and clicking “Campaign Templates”.
Campaign Components
Once you’ve created a campaign, campaign components are automatically generated to promote across user touchpoints. Navigate to “Components” on the campaign page to access and customize:- Landing pages direct users to your partnership and prompt them to link their reward accounts. You can customize the theme, background image, text, button color, and button text. Additionally, you can select which active campaign(s) to highlight on the landing page. You can also configure an inactive state for the landing page, displayed when a campaign has ended. Toggle the inactive state on in the landing page settings and set a custom title and intro message. Configuring this ensures members see a clean, branded experience rather than a broken page after a campaign concludes.
- Connect buttons can be added directly to a partner experience to direct users to link their accounts using the Benji Connect SDK.
Transactional Emails
Benji can be configured to send campaign transactional emails to users, or you can listen for webhooks to configure your own transactional email system.- Account linking confirmation emails highlight partnership benefits and showcase active campaigns.
- Earn campaign confirmation emails notify users when an earn transaction has been completed, providing transaction details and driving engagement with your rewards program.