Integrate your customer data with your My Account page using the API v2 Feeds

Steps to integrate your webinar data with your meeting software

1 1. Prerequisites
2 2. Planning your integration
3 3. Developing & testing your integration
4 FAQs
5 Support

Related Help Guide Pages

Learn how to use the API Feeds to integrate your customers' details with your My Account page.

There are many reasons you might want to integrate your accessplanit platform with a "My Account" page on your website. By synchronising your systems, you can ensure that your customers have access to their Course information and personal data all in one place, reducing the need for them to access multiple systems, removing the need for you to make manual updates in two systems, which in turn minimises the risk of errors. This not only saves valuable time for your team but also improves data accuracy in both systems!

Providing users with real-time updates on their account status, course registrations, and progress allows for better transparency and convenience. Additionally, as automating data synchronisation between your accessplanit platform and your website's "My Account" page significantly reduces the chance of human error, this means a more reliable and user-friendly experience for your customers.

As your business grows, the scalability of an integration will enable you to handle an increasing number of customers efficiently!

While there are a number of different ways to integrate your webinar data between your accessplanit platform and your [what] software, this guide will focus on how to complete this integration using the accessplanit API v2 feeds. APIs give you real-time access to your data, they keep information consistent, and can grow with your needs, supporting custom data elements. Overall, APIs are a reliable and flexible way to link different systems and services together, making everything work together more easily.

Follow this page to learn the steps to integrate the [what] data in your accessplanit platform with your [what] software using the accessplanit v2 API Feeds.

1. Prerequisites

Before you start planning the details your integration, we recommend that you make sure you have everything you need for an integration

The following steps should be followed:

Ensure your meeting software supports Integrations via an API
Explore your options for how your integration will be created (who will be developing it)

Ensure your connecting software supports Integrations via an API

Before you begin planning your integration, we recommend confirming that your [what] software will support the integration.

To confirm that an integration is possible, you should work with an internal expert or product owner, or your key contact from your [what] software. Here are several areas to confirm:

Check that the software is capable of supporting API integrations, this includes ensuring it can handle HTTP requests, and it supports data in a JSON data format.
Check if there are any additional licences/fees or permissions required to set up an integration using APIs

Explore your options for how your integration will be created (who will be developing it)

Review your options for who could develop this integration for you; you may have an internal development team, an external third party that you have worked with before, or your meeting software supplier may have developer recommendations or be able to complete the integration themselves.

Here are a few of the considerations when deciding who will work on your integration:

Experience
Working with a developer who has worked with websites previously is a benefit, particularly if they have experience with your specific meeting software and/or accessplanit. They should be proficient in JSON and REST.
Quote and pricing models
While it is unlikely that you will be able to request a quote at this stage, understanding their pricing model is important to know, some developers will charge a fixed price for a project, whereas others will charge a daily rate. Ensure that you are aware of what this quote includes, as some quotes also factor in additional services and support.
Reputation/reviews
If it is your first time working with a third party developer, you may wish to ask for their reviews and/or testimonials.
Development process
Understanding what methodology the developer follows helps to ensure their approach will fit into your process, for example if you need to be able to re-evaluate approaches and iterate throughout the project a ‘waterfall’ approach would not be suitable.
Timeline
Understanding the developers availability and lead times is the first step to knowing if they will be able to deliver within your project timeframes, once you have scoped the integration during the next phase in 'planning' you will be able to confirm this.
Support
Understand what support will be available to you post-launch (this should include technical assistance and bug fixes), and whether there are any additional charges for these services.

2. Planning your integration

In this step you will work with your developer to plan your integration

There are two key steps for planning your website integration:

Understand common set-ups and best practice
Define what and how data will be shared within your integration

Understand common set-ups and best practice

Depending on your requirements, there are 2 key processes that can be automated for MY Account page integrations:

User details integration
Users may be created in your accessplanit platform, your website, or both! The details of new Users will need to be shared with the other system. Additional any User detail updates, such as contact information changes, should be synchronised to the other system.
Delegate integration
As Users are registered onto Courses, the details of these Delegate record should be shared with the website to be included in the user’s My Account area, additionally any changes (such as cancellations) should be shared between the two systems.

Here are recommendations for each of the above processes, including example filters and data to use with each. For your integration planning, please note these examples are not exhaustive and additional data is available in each of the available endpoints.

a. New User is created in accessplanit

Process triggered

Automatically (via web-hooks - coming soon), as soon as a User has been created

Filter criteria

Only Users with a status of ‘Enabled’ or ‘New’
Example optional filter: Only Users allocated to a specific Companies

Data included

Use accessplanit API v2 endpoints:

User

Recommended data fields to include:

ID (Unique ID of the User e.g. jasmit)
Forenames (User’s first name e.g. James)
Surname (User’s last name e.g. Smith)
ExternalID (ID of the User as it is stored in another platform, this could be the ID used for the User in your website/CMS)
MainCompanyID (Unique ID of the User’s Main Employment Company e.g. DOEV908E)
MainCompanyName (Name of the User’s Main Employment Company e.g. Douglas Group)
MainRoleID (ID of the User’s main level of access in the accessplanit platform)
MainRoleLabel (Label of the User’s main level of access in the accessplanit platform)
Status (Status of the User e.g. Enabled)
DateCreated (Date & Time the User was created e.g. 2025-02-22T11:01:38.17)
FullAddress (User’s main address e.g. 1 Main Street Lancaster Lancashire United Kingdom LA1 1AB)
Email (User’s main email address)
Phone (User’s phone number)
Mobile (User’s mobile number)
MarketingOptIn (If the user has opted into receive marketing communications e.g. true)
BillingAddress, BillingTown, BillingCounty, BillingCountry, BillingPostcode, BillingEmail, BillingPhone (User’s billing address fields)
ShippingAddress, ShippingTown, ShippingCounty, ShippingCountry, ShippingPostcode, ShippingPhone (User’s shipping address fields)

User Custom Fields

For powerful and customised integrations, in addition to the above recommended fields, you can also access all of your User-based Custom Fields directly using the above feed.

b. New User is created on your website

Process triggered

Automatically, as soon as a User has been created via your website

Filter criteria

n/a

Data included

Use accessplanit API v2 endpoints, make a POST request to:

User

Recommended data fields to include:

Forenames (User’s first name e.g. James)
Surname (User’s last name e.g. Smith)
ExternalID (ID of the User as it is stored in another platform, this could be the ID used for the User in your website/CMS)
MainCompanyID (Unique ID of the User’s Main Employment Company e.g. DOEV908E)
MainRoleID (ID of the User’s main level of access in the accessplanit platform)
Address (User’s Main address e.g. 1 Main Street)
Town (User’s Main Town e.g. 1 Lancaster)
County (User’s Main County e.g. Lancashire)
Postcode (User’s Main Postal/Zip code e.g. LA1 1AB)
Country (User’s Main Country e.g. United Kingdom)
Email (User’s main email address)
Phone (User’s phone number)
Mobile (User’s mobile number)
MarketingOptIn (If the user has opted into receive marketing communications e.g. true)
BillingAddress, BillingTown, BillingCounty, BillingCountry, BillingPostcode, BillingEmail, BillingPhone (User’s billing address fields)
ShippingAddress, ShippingTown, ShippingCounty, ShippingCountry, ShippingPostcode, ShippingPhone (User’s shipping address fields)

User Custom Fields

For powerful and customised integrations, in addition to the above recommended fields, you can also access all of your User-based Custom Fields directly using the above feed.

c. Existing User is updated in accessplanit

Process triggered

Automatically (via web-hooks - coming soon), as soon as a User has been updated

Filter criteria

Only Users with a status of ‘Enabled’ or ‘New’
Example optional filter: Only Users allocated to a specific Companies

Data included

Use accessplanit API v2 endpoints:

User

Recommended data fields to include:

ID (Unique ID of the User e.g. jasmit)
Forenames (User’s first name e.g. James)
Surname (User’s last name e.g. Smith)
ExternalID (ID of the User as it is stored in another platform, this could be the ID used for the User inyour website/CMS)
MainCompanyID (Unique ID of the User’s Main Employment Company e.g. DOEV908E)
MainCompanyName (Name of the User’s Main Employment Company e.g. Douglas Group)
MainRoleLabel (Label of the User’s main level of access in the accessplanit platform)
Status (Status of the User e.g. Enabled)
DateUpdated (Date & Time the User was updated e.g. 2025-02-22T11:01:38.17)
FullAddress (User’s main address e.g. 1 Main Street Lancaster Lancashire United Kingdom LA1 1AB)
Email (User’s main email address)
Phone (User’s phone number)
Mobile (User’s mobile number)
MarketingOptIn (If the user has opted into receive marketing communications e.g. true)
BillingAddress, BillingTown, BillingCounty, BillingCountry, BillingPostcode, BillingEmail, BillingPhone (User’s billing address fields)
ShippingAddress, ShippingTown, ShippingCounty, ShippingCountry, ShippingPostcode, ShippingPhone (User’s shipping address fields)

d. Existing User is updated on the website

Process triggered

Automatically, as soon as a User’s details have been updated via the website

Filter criteria

n/a

Data included

Use accessplanit API v2 endpoints, make a PUT request to:

User (using the Unique ID of the User e.g. jasmit)

Recommended data fields to include:

ID (Unique ID of the User e.g. jasmit)
Forenames (User’s first name e.g. James)
Surname (User’s last name e.g. Smith)
ExternalID (ID of the User as it is stored in another platform, this could be the ID used for the User in your website/CMS)
MainCompanyID (Unique ID of the User’s Main Employment Company e.g. DOEV908E)
MainRoleID (ID of the User’s main level of access in the accessplanit platform)
Status (Status of the User e.g. Enabled)
Address (User’s Main address e.g. 1 Main Street)
Town (User’s Main Town e.g. 1 Lancaster)
County (User’s Main County e.g. Lancashire)
Postcode (User’s Main Postal/Zip code e.g. LA1 1AB)
Country (User’s Main Country e.g. United Kingdom)
Email (User’s main email address)
Phone (User’s phone number)
Mobile (User’s mobile number)
MarketingOptIn (If the user has opted into receive marketing communications e.g. true)
BillingAddress, BillingTown, BillingCounty, BillingCountry, BillingPostcode, BillingEmail, BillingPhone (User’s billing address fields)
ShippingAddress, ShippingTown, ShippingCounty, ShippingCountry, ShippingPostcode, ShippingPhone (User’s shipping address fields)

e. Delegate is registered onto a Class or Web Course in accessplanit

Process triggered

Automatically (via web-hooks - coming soon), as soon as a Delegate has been registered

Filter criteria

Recommended criteria:

Only Delegates with a status of ‘Booked', ‘Provisional’, ‘In Progress’, and 'Completed’
Example optional filter: Only Delegates allocated to a specific Companies
Example optional filter: Only Delegates allocated to a specific Training Providers
Example optional filter: Only Delegates allocated to a specific Courses

Data included

Use accessplanit API v2 endpoints:

User
UserCourseDate

Recommended User data fields to include:

Forenames (User’s first name e.g. James)
Surname (User’s last name e.g. Smith)
ExternalID (ID of the User as it is stored in another platform, this could be the ID used for the User in your website/CMS)
Address (User’s Main address e.g. 1 Main Street)
Town (User’s Main Town e.g. 1 Lancaster)
County (User’s Main County e.g. Lancashire)
Postcode (User’s Main Postal/Zip code e.g. LA1 1AB)
Country (User’s Main Country e.g. United Kingdom)
Email (User’s main email address)
Phone (User’s phone number)
Mobile (User’s mobile number)
MarketingOptIn (If the user has opted into receive marketing communications e.g. true)

Recommended UserCourseDate data fields to include:

CourseDateID (Unique ID of the Course Date e.g. 12368)
ID (Unique ID of the Delegate e.g. pebrid~12368)
UserID (Unique ID of the User e.g. pebrid)
UserFullName (Full name of the User/Delegate e.g. Peter Bridge)
CandidateEmailAddress (Email address of the User/Delegate e.g. pd1987@email.com)
Status (Delegate status on the Course e.g. ‘Completed’)
DateCreated (Date & Time the Delegate was created, e.g. 2025-02-22T11:01:38.17)
Description (Name of the Delegate, Course, and Course Date, e.g. James Smith- First Aid at Work: 06/12/2025 09:00 - 07/12/2025 13:15)

User & Delegate Custom Fields

For powerful and customised integrations, in addition to the above recommended fields, you can also access all of your User & Delegate-based Custom Fields directly using the above feeds.

f. Delegate is registered onto an eLearning Course in accessplanit

Process triggered

Automatically (via web-hooks - coming soon), as soon as an eLearning Delegate meets the filter criteria

Filter criteria

Recommended criteria:

Only Delegates with a status of ‘Booked', ‘Provisional’, ‘In Progress’, and 'Completed’
Example optional filter: Only Delegates allocated to a specific Companies
Example optional filter: Only Delegates allocated to a specific Training Providers
Example optional filter: Only Delegates allocated to a specific Courses

Data included

Use accessplanit API v2 endpoints:

UserCourseDateELearning

Recommended UserCourseDateELearning data fields to include:

CourseName (Name of the Course Template e.g. First Aid)
CourseExternalID (ID of the Course Template as it is stored in another platform, this could be the ID used for the Course in your website/CMS)
CourseID (Unique ID of the Course Template e.g. FIRS452VR)
CourseCompanyName (Name of the Training Provider offering the Course)
UserFullName (Full name of the User/Delegate e.g. Peter Bridge)
UserID (Unique ID of the User e.g. pebrid)
CompanyName (Name of the Delegate’s Company e.g. Douglas Group)
DateStamp (Date & Time the Delegate was created, e.g. 2025-02-22T11:01:38.17)
PackageStartDate (Date & Time the Delegate can start the Course from, e.g. 2025-02-22T11:01:38.17)
PackageExpiryDate (Date & Time the Delegate should complete the Course by, e.g. 2025-02-22T11:01:38.17)
AllowStart (If the Delegate is allowed access to start eLearning Course)
CompletionStatus (If the Delegate has completed the eLearning Course)
SuccessStatus (If the Delegate has passed the eLearning Course)
Status (Delegate status on the Course e.g. ‘Booked’)
Score (Delegate score on the Course e.g. ‘72’)

g. Delegate is updated in accessplanit

Process triggered

Automatically (via web-hooks - coming soon), as soon as the Delegate meets the filter criteria

Filter criteria

The Delegate’s ‘date updated’ has changed
Example optional filter: Only Delegates allocated to a specific Companies
Example optional filter: Only Delegates allocated to a specific Training Providers
Example optional filter: Only Delegates allocated to a specific Courses

Data included

Use accessplanit API v2 endpoints:

UserCourseDate

Recommended data fields to include:

CourseDateID (Unique ID of the Course Date e.g. 12368)
ID (Unique ID of the Delegate e.g. pebrid~12368)
UserID (Unique ID of the User e.g. pebrid)
UserFullName (Full name of the User/Delegate e.g. Peter Bridge)
CandidateEmailAddress (Email address of the User/Delegate e.g. pd1987@email.com)
Status (Delegate status on the Course e.g. ‘Cancelled’)
DateCreated (Date & Time the Delegate was created, e.g. 2025-02-22T11:01:38.17)
Description (Name of the Delegate, Course, and Course Date, e.g. James Smith- First Aid at Work: 06/12/2025 09:00 - 07/12/2025 13:15)

h. Delegate is updated via the website

Process triggered

Automatically, as soon as a the Delegate is updated in your website

Filter criteria

n/a

Data included

Use accessplanit API v2 endpoints, make a PUT request to:

UserCourseDate (using the ID of the Delegate e.g. jasmit~12345)

Recommended UserCourseDate data fields to include:

Status (Delegate status on the Course e.g. ‘Completed’)
Score (Delegate status on the Course e.g. ‘63’)

Define what and how data will be shared within your integration

Once you have reviewed the common set-ups and best practice for [what] integrations above, you should define the inputs and output for integrating your courses into your website.

Work with your [development] team to define your integration! Here are the steps to follow for each process you want to integrate:

How will your integration for this process be triggered? Will it be triggered based on something being created or updated, e.g. when an [what] is marked as ‘Advertised’? Or will it be triggered periodically, such as once a day or once an hour?