Skip to main content

SparkFly

Sam Lewis

Using the SparkFly Integration

The SparkFly integration connects SmarterSends to your SparkFly offer-management account. It allows approved SparkFly offers to be added to campaign templates and used to generate recipient-specific offer content and redemption credentials.

 

Availability

The integration is available when SparkFly has been enabled for your SmarterSends account.

Different parts of the workflow require different access:

  • Account owners configure or remove the integration.
  • Template managers configure SparkFly Offer content areas.
  • Group administrators assign eligible stores to groups.
  • Campaign creators select offers when building campaigns.

 

Connecting SparkFly

Account owners can configure the integration:

  1. Open Settings.
  2. Select Integrations.
  3. Select SparkFly.
  4. Enter the SparkFly Identity.
  5. Enter the SparkFly API Key.
  6. Select the appropriate endpoint:
    • Staging for testing.
    • Live for production.
  7. Select Test API Access.

When authentication succeeds, SmarterSends displays API Access Successful and loads the available merchants and channels.

Completing the Integration Settings

After API access is validated:

  1. Enter the Webhook URL supplied for your SparkFly implementation.
  2. Select the appropriate Merchant.
  3. Select the Channel used for campaigns created by SmarterSends.
  4. Choose whether campaign users can set an expiration date.
  5. Select Save.

The following fields are required:

  • Identity
  • SparkFly API Key
  • Webhook URL
  • Merchant
  • Channel

The Webhook URL must be a valid URL.

Staging and Live Endpoints

Use the Staging endpoint while validating credentials, offer templates, and campaign behavior.

Switch to the Live endpoint only when you are ready to create production SparkFly campaigns. Confirm that you are using the correct production credentials, merchant, channel, and webhook before saving.

If credentials or the endpoint change, test API access again and reselect the merchant and channel when necessary.

 

Configuring a SparkFly Offer Content Area

A template manager must add a SparkFly Offer content area to a campaign template before campaign creators can select offers.

  1. Open Templates.
  2. Create or edit a template.
  3. Add a content area.
  4. Select SparkFly Offer as the content-area type.
  5. Select the offers users may choose.
  6. Configure the offer HTML.
  7. Save and publish the template.

You can allow:

  • All approved SparkFly offers.
  • Only selected approved offers.

Only approved offers returned by SparkFly are available. Recently approved or updated offers may take up to approximately 15 minutes to appear.

 

Formatting Offer Content

The SparkFly Offer content area supports response fields that are replaced with offer and campaign information.

Available fields include:

  • credential_identifier
  • offer_state_id
  • offer_name
  • offer_short_name
  • offer_description
  • campaign_name
  • offer_mobile_image_url
  • offer_mobile_image_thumb
  • offer_web_image_url
  • offer_web_image_thumb
  • activates_at
  • expires_at

Template managers can insert these fields into the offer HTML to control how the offer is displayed.

For example, the template can display:

  • The offer name and description.
  • A recipient’s redemption code.
  • The expiration date.
  • SparkFly-hosted offer images.
  • The SparkFly campaign name.

Preview and test the layout before publishing the template.

 

Selecting an Offer in a Campaign

When a campaign uses a template containing a SparkFly Offer content area:

  1. Open the campaign.
  2. Locate the SparkFly Offer section.
  3. Select an offer.
  4. Select an expiration date when required.
  5. Select one or more eligible stores when required.
  6. Continue reviewing and scheduling the campaign.

The available offers are limited by the template’s eligible-offer settings.

The available stores are limited to those assigned to the current group.

Expiration Dates

If expiration-date selection is enabled, the campaign creator must choose an expiration date. Dates before the current date cannot be selected.

The selected date determines when the SparkFly campaign should stop displaying the offer.

Confirm that the date aligns with:

  • The underlying SparkFly offer’s availability.
  • The campaign schedule.
  • Any legal or promotional requirements.

 

Removing an Offer From a Campaign

To clear a SparkFly selection:

  1. Locate the SparkFly Offer section.
  2. Select Remove Offer.

This clears the selected offer, expiration date, and stores from that campaign content area.

 

Previewing SparkFly Content

During preview, SmarterSends retrieves the selected offer’s details from SparkFly and displays them using the configured HTML.

The preview may include:

  • Offer name
  • Offer description
  • Activation date
  • Expiration date
  • Offer images
  • A sample redemption code

The preview uses SAMPLECODE in place of a real recipient credential. Actual credentials are generated or retrieved for recipients during campaign delivery.

 

What Happens When the Campaign Is Scheduled

When a SparkFly-enabled campaign is prepared for delivery, SmarterSends creates or updates a campaign in SparkFly using:

  • The selected offer.
  • The SmarterSends campaign name.
  • The configured SparkFly channel.
  • The selected expiration date.
  • The selected eligible store numbers.
  • A SmarterSends campaign reference.

SparkFly returns a campaign identifier that is added to the outgoing campaign content.

During delivery, the configured webhook uses the recipient identifier and SparkFly campaign identifier to retrieve recipient-specific offer information. The returned values populate the response fields in the template.

Because the final offer is personalized at delivery time, the recipient’s content or credential may differ from the sample shown in the preview.

 

Updating a Scheduled Campaign

If a SparkFly campaign has already been created and the SmarterSends campaign is rescheduled or updated, SmarterSends attempts to update the existing SparkFly campaign rather than creating a duplicate.

Always review the selected offer, stores, and expiration date before rescheduling.

 

Removing the Integration

Account owners can remove the connection:

  1. Open Settings.
  2. Select Integrations.
  3. Open SparkFly.
  4. Select Remove Integration.

Removing the integration clears the SparkFly settings from SmarterSends. It does not delete merchants, offers, stores, or campaigns from SparkFly.

After removal:

  • Offers can no longer be loaded from SparkFly.
  • SparkFly Offer content areas cannot be completed successfully.
  • SparkFly-enabled campaigns may fail validation or delivery preparation.

 

Troubleshooting

API Access Failed

Confirm the Identity, API Key, and selected endpoint. Staging and production credentials may be different.

No merchants or channels are available

Confirm that the credentials have access to the expected SparkFly account and endpoint, then test API access again.

An offer is missing

Confirm that the offer is approved, belongs to the configured merchant, and is permitted by the template. Allow time for the offer list to refresh.

No stores are available

Confirm that store selection is enabled and that SparkFly stores have been assigned to the current group.

The expiration date is required

Your organization requires campaign creators to set an expiration date for SparkFly offers.

The preview shows SAMPLECODE

This is expected. Recipient-specific credentials are retrieved during campaign delivery.

Offer content is incomplete

Review the SparkFly offer data and confirm that the HTML uses valid response fields. An image or field may remain empty when the selected offer does not provide that value.

SparkFly campaign creation fails

Confirm that the integration is connected to the correct endpoint and that the selected offer, merchant, channel, stores, and expiration date remain valid.

Comments

0 comments

Article is closed for comments.

Powered by Zendesk