Evergent

Configuration guide for the Evergent connector in Recurly Engage—activation, data sync, and supported subscription actions.

Overview

The Evergent integration lets you synchronize subscriber data and trigger subscription management actions from within Recurly Engage prompts by connecting to your Evergent REST API.

Required plan

This feature or setting is available to all customers on any Recurly Engage subscription plan.

Prerequisites & limitations

  • Company or App Administrator permissions in Recurly Engage.
  • Uses the Evergent REST API; legacy SOAP-only setups may require Customer Success assistance.

Definition

Evergent Connector for Recurly Engage synchronizes subscriber traits from Evergent and enables prompt-driven subscription workflows (coupon redemption, service changes, pauses, resumes, etc.).

Key benefits

  • Real-time subscriber data: Import detailed subscription traits for precise segment targeting.
  • Seamless subscription control: Execute subscription actions (pause, resume, change service) directly from prompts.
  • Customizable workflows: Tailor actions to your Evergent instance and business logic.

Key details

Activation

To enable the Evergent connector under Settings > Connectors, provide:

  • Domain: Your Evergent API domain.
  • apiKey: Your Evergent REST API key.
  • channelPartnerID: Your channel partner identifier.

Data integration

Schedule a daily CSV export from Evergent into Recurly Engage via S3. The CSV should include the following subscriber traits for audience targeting:

Trait NameDescription
customer_idCustomer/User ID
business_unitBusiness unit owning subscription
countryBilling country
current_payment_method[Google Wallet, App Store Billing, Credit Card, Roku Payment, Coupon, etc]
pack_idPackage ID
packagePackage Name
pack_pricePackage Price
pack_typePackage Type
currency_code3-character currency code
valid_from_dateBilling period start
valid_to_dateBilling period end
payment_status[Declined, Posted]
payment_type[Renewal, Purchase]
payment_dateDate of most recent payment
declined_reasonReason for payment decline
promotion_amountPromotion amount (if applicable)
promotion_codePromotion code (if applicable)
coupon_codeCoupon code (if applicable)
cancellation_requested_dateDate of cancellation request (if applicable)
classificationSubscription classification status ([Paid, Free Trial, Retail, etc])

Supported actions

📘

Important:

Evergent configurations can vary; verify which APIs your instance supports.

ActionDescriptionAPI Method
Redeem CouponApply a coupon code to an existing package/productredeemCoupon
Change ServiceUpgrade or downgrade an existing service (specify from and to services)changeService
Pause SubscriptionPause an active subscription for up to 90 dayspauseSubscription
Resume SubscriptionResume a previously paused subscriptionresumeSubscription
Reactivate SubscriptionReactivate a subscription marked for cancellation (subject to package terms)reactivateSubscription
Remove SubscriptionRemove (cancel) a subscription at period endremoveSubscription