Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Learn how to use the API Feeds to integrate your customer details with your CRM platform.
There are many reasons you might want to integrate your accessplanit platform with a CRM to manage your customer data effectively. By synchronising your systems, you can ensure that customer information is always up-to-date in both platforms, reducing the need for manual data entry and minimising the risk of errors. This not only saves valuable time for your team but also helps maintain data accuracy.
Keeping your account managers informed with real-time data updates allows them to provide better service to your customers, and make informed decisions quickly, enhancing your overall customer relationship strategy! Additionally, automating data synchronisation between your accessplanit platform and your CRM can significantly reduce human error, leading to more reliable customer insights and improved relationship management.
As your business grows, the scalability of an integration with your CRM system enables you to manage an increasing volume of customer data and interactions efficiently.
While there are a number of different ways to integrate your customer data between your accessplanit platform and your CRM 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 customer data in your accessplanit platform with your CRM 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 CRM 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 CRM. 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 CRMs previously is a benefit, particularly if they have experience with your specific CRM 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 up to 3 key processes that can be automated for CRM integrations:
Account / Company Integration When your customer base changes; such as new customers (Accounts/Companies) being created, existing customers being updated or deleted, these changes should be shared between your accessplanit platform and your CRM
User Integration When your customers have changes to their employees (Users); such as new key contacts/Users being created, existing Users are updated or deleted, these changes should be shared between your accessplanit platform and your CRM
Booking / Activity Integration Account activity recorded in your accessplanit platform, such as bookings and notes, should be shared with your CRM
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 Account is created in accessplanit
Process triggered
Automatically (via web-hooks - coming soon), as soon as an Account has been created
Filter criteria
Only Companies with a status of ‘Enabled’ or ‘New’
Example optional filter: Only Companies allocated to a specific Company Group
Data included
Use accessplanit API v2 endpoints:
Company
Recommended data fields to include:
ID (Unique ID of the Company e.g. DOEV908E)
Name (Name of the Company e.g. Douglas Group)
ExternalID (ID of the Company as it is stored in another platform, this could be the ID used for the Company in the CRM)
CompanyGroupNames (Groups this Company is allocated to e.g. Enterprise, Key Accounts)
DateCreated (Date & Time the Company was created e.g. 2025-02-22T11:01:38.17)
Status (Status of the Company e.g. Enabled)
Phone (Company’s phone number)
Email (Company’s main email address)
FullAddress (Company’s main address e.g. 1 Main Street<br />Lancaster<br />Lancashire<br />United Kingdom<br />LA1 1AB)
MainContactUserLabel (Name of the main contact for the customer)
AccountManagerName (Name of the internal contact looking after the customer)
Account Custom Fields
For powerful and customised integrations, in addition to the above recommended fields, you can also access all of your Account-based Custom Fields directly using the above feed.
b. New Account is created in the CRM
Process triggered
Automatically, as soon as an Account has been created in the CRM
Filter criteria
n/a
Data included
Use accessplanit API v2 endpoints, make a POST request to:
Company
Recommended data fields to include:
Name (Name of the Company e.g. Douglas Group)
ExternalID (ID of the Company as it is stored in another platform, this could be the ID used for the Company in the CRM)
CompanyGroupIDs (Groups this Company is allocated to e.g. HEADGROUP)
Status (Status of the Company e.g. Enabled)
Phone (Company’s phone number)
Email (Company’s main email address)
Address (Company’s Main address e.g. 1 Main Street)
Town (Company’s Main Town e.g. 1 Lancaster)
County (Company’s Main County e.g. Lancashire)
Postcode (Company’s Main Postal/Zip code e.g. LA1 1AB)
Country (Company’s Main Country e.g. United Kingdom)
MainContactUserID (ID of the main contact for the customer)
AccountManagerID (ID of the internal contact looking after the customer)
Account Custom Fields
For powerful and customised integrations, in addition to the above recommended fields, you can also access all of your Account-based Custom Fields directly using the above feed.
c. Existing Account is updated in accessplanit
Process triggered
Automatically (via web-hooks - coming soon), as soon as an Account has been updated
Filter criteria
Only Companies with a status of ‘Enabled’ or ‘New’
Example optional filter: Only Companies allocated to a specific Company Group
Data included
Use accessplanit API v2 endpoints:
Company
Recommended data fields to include:
ID (Unique ID of the Company e.g. DOEV908E)
Name (Name of the Company e.g. Douglas Group)
ExternalID (ID of the Company as it is stored in another platform, this could be the ID used for the Company in the CRM)
CompanyGroupNames (Groups this Company is allocated to e.g. Enterprise, Key Accounts)
DateUpdated (Date & Time the Company was last updated e.g. 2025-02-26T11:01:38.17)
Status (Status of the Company e.g. Enabled)
Phone (Company’s phone number)
Email (Company’s main email address)
FullAddress (Company’s main address e.g. 1 Main Street<br />Lancaster<br />Lancashire<br />United Kingdom<br />LA1 1AB)
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.
h. New User is created in the CRM
Process triggered
Automatically, as soon as a User has been created in the CRM
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 the CRM)
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)
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.
i. 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 in the CRM)
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<br />Lancaster<br />Lancashire<br />United Kingdom<br />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)
