topic Re: API integrations requirement for Event Registration in APIs & Integrations

API integrations requirement for Event Registration

MunawarKazi1988 — Thu, 31 Oct 2024 14:24:09 GMT

Hi, I’m looking for some insight/help.

I’m organising an event and using a third-party company (Jemex - https://www.jemexideas.com/) to help with the registrations.

In our requirements for our registration system this year, I have asked our registration supplier, Jemex, to investigate the possibility of linking the registration system with HubSpot, so any registration, attendance and demographic lists can be communicated between the system automatically via an API and not Excel spreadsheets.

In a call this morning, Jemex, our supplier, asked if I have an API integration document from HubSpot. Is this something that one of you could help with?

I’ve come across the below points but am not really sure how best to reply to our supplier Jemex with the correct information.

HubSpot API Documentation: HubSpot provides comprehensive API documentation, which can guide Jemex in developing a secure integration. You can access this at HubSpot's Developer Documentation. This resource offers detailed information on endpoint specifications, authentication requirements, and example calls.
API Scopes and Permissions: For data security and functionality, check that Jemex is aware of the necessary API scopes—particularly regarding contact, event, and attendance data. Make sure the integration's permissions are scoped correctly to allow the sharing of registration, attendance, and demographic data.
Data Mapping and Field Alignment: It’s best to map out the exact fields required from both systems (e.g., name, email, company, attendance status) to ensure consistency between the two databases. Clarifying these fields in advance helps avoid data misalignment and ensures relevant fields in HubSpot are prepared to accept incoming data.
Testing Environment: If available, setting up a sandbox environment in HubSpot for testing purposes can be valuable. It allows Jemex to trial the integration without affecting live data, helping catch and resolve any issues before full deployment.
Error Handling and Sync Frequency: Discuss with Jemex how often data syncs will occur (e.g., real-time or scheduled batch uploads) and ensure there’s a mechanism for error handling and retries, especially if the API experiences a temporary outage.

Re: API integrations requirement for Event Registration

Jaycee_Lewis — Fri, 01 Nov 2024 20:40:05 GMT

Hey, @MunawarKazi1988 👋 I have a few suggestions for you.

If this integration is only for one specific portal, you can use Private Apps for the auth. If this is something that could potentially be used in multiple portals, you'll need to look into building a Public App and utilizing OAuth for the authentication
For either of the above auth options, detailed information on scopes, and what subscription levels are required, can be found here — Scopes (this is important as you don't want to use endpoints that require scopes that your portal doesn't have access to potentially)
For testing, I'd recommend creating an App Developer account and at least one Developer Test account. The Developer Test portal allows you to test your integration and not affect your production portal. They are free and offer most of the functionality of an Enterprise level portal
A few places to get stared with APIs are the CRM object endpoints — Contacts, Companies, etc., Custom Marketing Events — knowledge base and API doc, and the Properties API if you need to create any custom properties

Have fun building!

Best,

Jaycee

Re: API integrations requirement for Event Registration

MunawarKazi1988 — Mon, 04 Nov 2024 16:42:21 GMT

Hi Jaycee Lewis, thank you, I've; recieved the below from the Event registration company, could you advise best response?

I got the Initial feedback from IT today, they asking should we focus on CRM service in HubSpot. If yes, we should use the API Guides under the CRM and mainly the below API endpoint.

Create contacts
Update contacts
Associations (associate the contact with existing records or activities)

Could you let us know what is the services you are using in HubSpot. Please create an App developer account and Developer Test account for us if you can.

For testing, I'd recommend creating an App Developer account and at least one Developer Test account. The Developer Test portal allows you to test your integration and not affect your production portal. They are free and offer most of the functionality of an Enterprise level portal

Re: API integrations requirement for Event Registration

MunawarKazi1988 — Mon, 11 Nov 2024 16:53:22 GMT

@Jaycee_Lewis possible ot come back on the above please?

and a question for mthe events registratio ncompany - Do you have the app developer account and developer test account for us? So that we can look into it further.

How can I check if we have a app delveoper account?

Re: API integrations requirement for Event Registration

Jaycee_Lewis — Thu, 19 Dec 2024 17:14:59 GMT

Hey, @MunawarKazi1988 I hope you figured this out. For others who may have the same question, there isn't an obvious flag for dev accounts. You can “name” them something obvious so they are easier to find. Or you can navigate to your list of portals and search there. See screenshot:

You can also tell you are in the correct place because the sidebar menu is different:

Best,

Jaycee