Amplitude
Integration guide for sending Recurly Engage prompt events to Amplitude and syncing user data via CSV, Webhooks, or Export API.
Prerequisites
- You must have Company or App Administrator permissions in Recurly Engage.
- You must have an Amplitude account with a project API key and access to the SDK or Export API.
- For outbound events, the Amplitude JavaScript SDK must be initialized on your site.
Definition
- Outbound events: Use the running Amplitude JavaScript SDK to fire prompt events in-session.
- Inbound data sync: Import historical events and user traits through comma-separated values (CSV) uploads, webhooks, or scheduled Export API jobs.
Key benefits
Key details
Outbound events
For web-based devices, Recurly Engage uses the existing Amplitude JavaScript SDK instance to emit events. To confirm your SDK configuration and enable the integration, contact your Customer Success Manager or [email protected].
Enter your Project API Key
Enter your Amplitude Project API Key. See Amplitude authentication.
Event details
| Activity | Description |
| Recurly Engage Prompt Impression | A user has seen the prompt |
| Recurly Engage Prompt Dismiss | A user has dismissed the prompt by clicking close or outside (if enabled) |
| Recurly Engage Prompt Timeout | The prompt closed automatically due to a timer |
| Recurly Engage Prompt Decline | A user declined the prompt by clicking the decline button |
| Recurly Engage Prompt Click | A user accepted the prompt using the primary call-to-action (CTA) |
| Recurly Engage Prompt Holdout | A holdout user reached the prompt without exposure |
| Recurly Engage Prompt Click 2 | A user accepted using the secondary CTA |
Attributes sent with each event:
| Property | Description |
promo_id | Unique prompt identifier (from Details) |
promo_name | Prompt name |
variation_id | Experiment variation identifier (if any) |
variation_name | Variation name |
event_timestamp | When the event occurred |
Inbound data sync
Depending on your use case, you can import user or event data into Recurly Engage using these methods.
CSV export
Download one-off reports from Amplitude (make sure User ID is the first column) and upload them to Settings → User Traits → CSV Import in Pulse.
Webhook
Export API
For automated exports, work with your Customer Success team to schedule jobs using the Amplitude Export API. Provide an API key with appropriate permissions, and configure the schedule to sync data into Recurly Engage automatically.
📋 TODO before publishing:
- Confirm the title. The draft had none, so I used "Amplitude".
Updated 4 days ago