Giving Assistant Embed Code

January 11th 2017 Online Giving

The following document outlines how to embed the Giving Assistant chat box directly into a church website. Our Giving Assistant chat box feature is included free of charge with every account and is powered by our advanced donation chatbot technology which offers conversational style giving. Using the Giving Assistant can add another layer/method of giving to your church website. We recommend using the Giving Assistant on your church "methods of giving" or "why we give" or similar web pages. However, you are free to embed the Giving Assistant on any church web page as needed.


Embed Document Sections


Getting Started

  • The Giving Assistant chat box embed API requires an Online Giving account. If you have not already signed up, please visit our sign-up page to get started today.
  • Got a question or issue? Drop us a line at support@onlinegiving.cc. We shall be happy to guide you with the embed process.

Prerequisites

  • Active Account - If you have not already signed up for Online Giving, please visit our sign-up page to get started today.
  • Church Code - Your church code is the same as your church sub-domain. For example in https://mychurch.onlinegiving.cc the "mychurch" sub-domain is the church code. If you have a ".org" giving website your church code will be your subdomain plus "_org". For example: "mychurch_org".
  • Basic HTML Skills - Embedding anything on the internet requires very basic knowledge of HTML. If you are having trouble please do not hesitate to contact us.

Do I need to use a SSL/TLS (HTTPS) to use the Giving Assistant?

No, a SSL/TLS enabled web page is not required for use of the Giving Assistant. The donor will be redirected to your secure giving website before any sensative payment information will be obtained. However, we do recommend having a SSL/TLS enabled website when possible as it's a good security standard for your visitors.

Authentication

Are you a Ministry Platform church?
Great news, we've integrated directly with Ministry Platform. The Giving Assistant for Ministry Platform churches can be setup to share authentication from the MP portal. Please contact us to schedule a free installation in the MP Portal.

Giving Assistant Embed Code


The Giving Assistant Embed Code

Giving Assistant Embed Code Attributes

  • src - Required. Set to https://www.onlinegiving.org/assets/chatbox.js
  • data-id - Required. Set to og-chatbox-script
  • data-church-code - Required. Set to your church code. Your church code is the sub-domain of your giving website. For TLD .org domains please append _org after sub-domain (e.g. subdomain_org).
  • data-default-message - Required. Set to the text you wish to display by default to the user.
  • data-token-type - Optional. Set to mp-token for Ministry Platform Portal embedding only.
  • data-mp-token - Optional. Set to [MPP_User_Data] for Ministry Platform Portal embedding only.
  • data-container-id - Optional. Set to CSS selector of desired HTML element. For use when it's desirable to place embed tag in main template.
  • data-header-text - Required. Set to text you wish to display in the chat box header text.
  • data-header-bg-color - Optional. Set to hex color code for background color of chat box header.
  • data-circle-bg-color-bot - Optional. Set to hex color code for background color of chat box circle for bot messages.
  • data-circle-bg-color-user - Optional. Set to hex color code for background color of chat box circle for user messages.
  • data-text-color - Optional. Set to hex color code for text color for chat box cirlce and header.

Using the Giving Assistant Embed Code


You may embed the Giving Assistant into any webpage that is located on your church website. The Giving Assistant uses a modern browser feature called CORS which allows for secure cross domain communitcation in the web browser. For security purposes the Giving Assistant can only be embedded into your church website and or a sub-domain of your church website. The inbound origin of each request will be verified by both OnlineGiving.org and the web browser for optimal security. For this reason any attempt to embed the Giving Assistant on a localhost or any other non-church website will result in a failed installation. We are happy to assist you with installation. To take advantage of our courtesy installation please contact us today.