We often hear from web designers and developers who are looking for ways to integrate NeonCRM with their websites. That's great news, because we offer a lot of options. While the API often seems like the obvious choice for a project, it’s important to understand that NeonCRM provides many out-of-the-box features that require much less work.
This article is organized based on specific tasks you may be trying to accomplish.
Customizing Web Forms
The most common question we get from web designers is how to integrate with NeonCRM's forms and pages. We have a few options, and often the simplest (our web template sync) is the most effective.
Web Template Copy
Once we have scraped the code and saved it to our server, it is not accessible to users. Only our team has access to make adjustments. This is necessary to maintain security. By using this approach, all of the forms remain on our servers and take advantage of our SSL certificate. Any changes made to the website will not be reflected on NeonCRM’s forms and pages until you notify our support team of the updates. Our team will then make the appropriate changes. This article explains the process in greater detail.
This solution meets the needs of the majority of NeonCRM customers.
You can find this feature by logging into NeonCRM and navigating to Global Settings icon > Global Settings > Forms & Web Pages > Custom CSS
Custom Form Builder Module
If you build a form that includes payment processing (donation or membership), you will be subject to some limitations:
- You must use a two-page flow.
- The payment page is hosted on NeonCRM’s servers and cannot be customized.
Email Signup Form
If you want to embed an email list signup form into your website, you can take advantage of an existing feature in NeonCRM called a Distribution List. Essentially, you can create an Email Audience that will output a signup form as an HTML code snippet. Any constituent who fills out this form will be added to this specific list. You can embed this code on your website and modify the markup.
DIY with the API
If the options presented above do not meet your needs, you may consider building a form using our API. The NeonCRM Developer Center provides developers access to our documentation on our Open API, Custom Objects, and Webhooks features.
Organizations often want to restrict access to content by putting it behind a login.
NeonCRM provides an out-of-the-box login area where constituents can access restricted content and manage their personal information. This area is configurable and works well for most situations we have encountered. This guide explains how to manage the login area.
If the included login area does not meet your needs, you can use our API’s AuthenticateUser method to create your own secure login area. This uses NeonCRM’s server as the authenticator of a user’s login credentials, but it does not grant that user a session for existing NeonCRM features. This solution cannot be used in conjunction with NeonCRM’s standard constituent login area.
NeonCRM can act as an OAuth 2.0 provider. This means that NeonCRM's existing login system can be used to authenticate access to a third-party website or service as a single sign-on. Click here to learn more.
Directories and Lookups
A very common request is to provide a constituent directory or lookup. This would be something like a member directory, a board member listing, or a location search.
NeonCRM offers an out-of-the-box membership directory. The criteria and output are configurable. You can also create multiple membership directories. This feature requires the Membership module, and is limited to displaying constituents with membership terms.
DIY with the API
Many developers have had success building lookup utilities through our API. The listAccounts method is a good starting point for a project like this.
The API has event methods available to do the following:
- List Events
- List Event Tickets
- Create Event Registration
- Retrieve Event Attendees
The Create Event Registration method has the following limitations:
- Sessions are not supported. You cannot register for sessions through the API.
- Registrations created through the API cannot automatically create NeonCRM accounts for attendees. However, you can use existing accounts for attendees by supplying their Account ID. Using the Create Account methods you can, in effect, produce the same result.
- Any discounts that have been previously configured in NeonCRM that apply to your event will be applied to the registration after it is submitted through the API. You may use the Calculate Event Registration API method to ensure the registration amount is correct prior to submitting this API request.
For more information regarding Event related methods and any further restrictions or limitations, please see our API documentation.
DIY with the API
A list of events can be retrieved using the listEvents API method.