Donations, simplified: Introduction to Embeddable Forms for Quick Action

Prerequisites

Important:

• In order to begin using the CharityEngine embeddable quick action forms, your organization will need to install the CharityEngine Public API key and include the following code on your website:

<script src="https://webapi.charityengine.net/api.js" async="" defer="defer"></script>

• For more details please review installing the CharityEngine Public Api on your website.
• NOTE: You do not need to include the web API if you are using CharityEngine apps like our CMS, Peer-to-Peer fundraising, Advocacy Action pages or other fundraising and engagement apps.
• Please ensure you have an experienced developer to assist and troubleshoot your web site. CharityEngine will not be able to assist with web site development. While the steps will render a basic view, this is an intentional design to allow a developer to type, render for your organization's marketing guidelines. Code is available for rendering by your developer.

Instructions - Developer: API - Installing the CharityEngine Public Web API

Please install the CharityEngine Public Web API before proceeding with quick action form embedding activities.

See more with our Help Center Article: Developer: API - Installing the CharityEngine Public Web API

Instructions - Donation Quick Action Form

Once you have the Public API installed on your site, you are ready to start using the embedded donation form.  There are two ways to embed the form using HTML or Javascript.

Step 1: Navigate to the Online App > Embeddable Widgets > Search & Manage > Create New > Donation Form 

Step 2: From the Design tab, update:

1. Headline
2. Top Content
3. Top Image
4. Button Background Color
5. Button Text Color
6. If leveraging Javascript, expand Configure Javascript for additional option
   Note: As changes are made from these options, the code under Embed Using HTML/Embed Using JavaScript will update.

Step 3: Click SAVE to secure your changes.

Step 4: Click Copy from either the "Embed Using HTML" or "Embed Using JavaScript"

Step 5: Add to your organization's web site

Important Note: If using HTML, please also: CE_API.SetApiKey("organziationskey"). This is the first line of the JavaScript script for reference as well.

Click here to read more about HTML configuration

Import Note: If using JavaScript, unlike the HTML method, using the CharityEngine JavaScript API only requires a few lines of JavaScript to load your Quick Action Form to your organization's web site. Then you can control the display and other configurations of the forms using our API.

Note: The CE API Key should be added to the header that wraps the script. While the <script> should be added to the body of the script. If using a platform such as WordPress, CharityEngine recommends adding as much scripting to the template area and the rendering components themselves.

Click here to read more about JavaScript configuration

Instructions - Sign Up Quick Action Form (for Communication/Opt In Lists)

Once you have the Public API installed on your site, you are ready to start using the embedded list opt-in form. (See Prerequisite above for more details)

Step 1: Navigate to the Online App > Embeddable Widgets > Create New > List Opt-In

Step 2: Select

1. Opt-In Lists: select one or more for donors to opt into
2. Selection Type: Auto or checkboxes
3. Default Initiative: Select an initiative 
4. Response Channel: Select a preferred response channel

Step 3: Select Copy from the bottom right to copy the code presented in the box and paste to install this widget on your organization's website. 

Step 4: Users can now easily enter information for list opt in. 

Below is an example which includes a general sign up as well as the option for a multiple list sign up:

FAQs & Additional Reading

Q. Is there any additional troubleshooting for API and web site issues?
A. If you are experiencing any unexpected behavior after following the directions above, visit our troubleshooting guide. Please ensure that as you inspect your website code, ensure that you are returning a successful page load first and then an initialization - demonstrating connection with the API. If these are successful then the troubleshooting will likely be associated with the web domain/3rd party host. You may experience issues with security parameters with your 3rd party host.

Q. I still don't see my buttons/experiencing web site issues.

Q. I would like to have the widget 'pop-up' for my users. Can this be achieved?
A. Yes - this can be achieved with the HTML coding only. Leverage the HTML coding and ensure you have also included the key in your scripting: ce-api-key="OrganizationNameAPI"

Q. Can I include a widget in a button?
A. Yes - a developer can integrate into a button for user to click to initiate the form itself.