Skip to content
English
Contact Support
  • There are no suggestions because the search field is empty.

API Integration

Tap into new streams of data and deliver a personalized customer experience by using Everfi’s API

Overview

Everfi’s Application Programming Interface (API) is ideal for organizations that need to automate data transfers between systems and simplify how they manage learners.  The API empowers organizations to connect Foundry with other systems, automate data transfers, and deliver personalized experiences. By leveraging the API, you can streamline workflows, gain deeper insights into learner engagement, and create a best-in-class data ecosystem.

Consumers expect relevant, personalized content. The Everfi API helps you use financial education program data to enhance customer journeys and improve operational efficiency.

Benefits of Using the Everfi API

  • Enhanced Data Tracking
    Access course data to better understand user behavior and engagement.

  • CRM Integration
    Combine Foundry data with your CRM for a complete customer view.

  • Stronger Personas
    Build detailed profiles to tailor experiences to user needs.

  • Increase Web Traffic
    Deliver personalized content that drives engagement.

  • Data Automation
    Automate data transfers between Foundry and other systems, reducing manual work and errors.

  • Enterprise-Level Efficiency
    Integrate HRIS, CRM, and other platforms to strengthen your data ecosystem.

What You Can Do with the API

  • Integrate third-party systems like HRIS and CRM.
  • Manage users: add, update, deactivate, or reactivate.
  • Retrieve user progress and learning activity.
  • Group learners by attributes (location, category, labels) for streamlined assignments.

How It Works

The Everfi API uses RESTful architecture and requires secure POST and GET requests over HTTPS (SSL encrypted). Authentication is handled via OAuth 2.0 using the client credentials grant workflow. Your system must support sending and receiving HTTP requests and responses in JSON format.

Steps to Connect
  1. Log into Foundry as an administrator.
  2. Navigate to Settings > Data Integration.
  3. Register an application for API access.
  4. Copy your client ID and client secret.
  5. Use OAuth 2.0 to exchange these credentials for an access token.
  6. Make API calls (e.g., Program User Data API) to retrieve user participation and progress.

Tip: To prevent invitations from being sent to newly added learners, include "is_invited": false in the JSON properties.

Setup and Timeline

  • This add-on service requires technical expertise and typically takes 1–3 weeks to implement.
  • Involve your IT team early to ensure a smooth setup.
  • Timeline may vary based on system complexity and data requirements.

Implementation Process
  1. Everfi enables API access.
  2. Everfi provides documentation.
  3. Your IT team builds and configures the integration.
  4. Test the API connection and review retrieved data.
  5. Share feedback with Everfi’s implementation team.

Detailed Documentation

Everfi provides a Postman Collection with templates, sample requests, and documentation to simplify setup.


To Access the Postman Collection
  1. Open the Postman desktop app.
  2. Choose your workspace.
  3. Visit the Everfi API Postman Collection page.
  4. Click Run in Postman.
  5. Select Postman for Mac or Windows.
  6. Confirm the collection has been imported into your workspace.

 

Important Note

  • Everfi does not offer out-of-the-box APIs. Customers can build APIs based on their requirements, or Everfi can recommend partners for custom development.

Next Steps

Ready to integrate? Contact Everfi Support for documentation and guidance on building your API connection.