### Install Givebutter Widgets Library Source: https://docs.givebutter.com/reference/reference-getting-started/docs This code snippet should be added inside the `` tag of your website to install the Givebutter Widgets library. Replace `YOUR_ACCOUNT_ID` with your actual Account ID. ```html ``` -------------------------------- ### Install Givebutter Widgets Library Source: https://docs.givebutter.com/reference/reference-getting-started/docs/widgets This code snippet should be added inside the `` tag of your website to install the Givebutter Widgets library. Replace `YOUR_ACCOUNT_ID` with your actual Account ID. ```html ``` -------------------------------- ### Givebutter Widgets Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/analytics This section outlines the available widgets for Givebutter campaigns, including Donate Buttons, Donation Forms, and Goal Bars. It also provides links to getting started guides and analytics for each widget. ```APIDOC Widgets: - Getting Started: /edit/widgets - Available Widgets: - Button: /edit/donate-button - Form: /edit/donation-form - Goal Bar [Coming soon!]: /edit/request-a-widget - Analytics: /edit/analytics ``` -------------------------------- ### Transactions API Endpoints Source: https://docs.givebutter.com/reference/reference-getting-started/reference/authentication Provides endpoints for managing transactions, including retrieving lists of transactions, getting specific transaction details, and creating new transactions. ```APIDOC Get Transactions: GET /transactions Get a Transaction: GET /transactions/{transaction_id} Create a Transaction: POST /transactions Request Body: (Transaction Object details) ``` -------------------------------- ### Campaigns API Endpoints Source: https://docs.givebutter.com/reference/reference-getting-started/reference/authentication Provides endpoints for managing campaigns, including retrieving a list of campaigns, getting a specific campaign, creating new campaigns, updating existing ones, and deleting campaigns. ```APIDOC Get Campaigns: GET /campaigns Get a Campaign: GET /campaigns/{campaign_id} Create a Campaign: POST /campaigns Request Body: (Campaign Object details) Update a Campaign: PATCH /campaigns/{campaign_id} Request Body: (Campaign Object details) Delete a Campaign: DELETE /campaigns/{campaign_id} ``` -------------------------------- ### Plans API Endpoints Source: https://docs.givebutter.com/reference/reference-getting-started/reference/authentication Provides endpoints for retrieving plan data, including lists of plans and details for individual plans. ```APIDOC Get Plans: GET /plans Get a Plan: GET /plans/{plan_id} ``` -------------------------------- ### Givebutter REST API Reference Source: https://docs.givebutter.com/reference/reference-getting-started/edit/events The main entry point for the Givebutter REST API documentation, providing comprehensive details on available endpoints and functionalities. ```APIDOC REST API: - API Reference: https://docs.givebutter.com/reference ``` -------------------------------- ### Givebutter Elements (Deprecated) Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/events Details the deprecated Givebutter Elements, including installation, dynamic elements, coded elements (Bubble, Button, Giving Form), analytics, and events. ```APIDOC Givebutter Elements (Deprecated): - Getting Started: /edit/elements-install - Dynamic Elements: /edit/elements-dynamic-elements - Coded Elements: - Bubble: /edit/elements-bubble - Button: /edit/elements-button - Giving Form: /edit/elements-type-form - Analytics: /edit/elements-analytics - Events: - Donation Events: /edit/elements-donation-events ``` -------------------------------- ### Givebutter Widgets Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-analytics This section outlines the available widgets for integration, including the Donate Button, Donation Form, and a Coming Soon Request Widget. It serves as a starting point for understanding Givebutter's widget functionalities. ```APIDOC Widgets: - Donate Button: For direct donation processing. - Donation Form: For collecting detailed donation information. - Request a Widget (Coming soon!): For requesting custom widget features. ``` -------------------------------- ### Givebutter API Reference Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-events This section outlines the structure of the Givebutter API documentation, detailing available widgets, deprecated elements, and the primary REST API reference. It serves as a starting point for developers integrating with Givebutter. ```APIDOC Widgets: Getting Started: /edit/widgets Available Widgets: Button: /edit/donate-button Form: /edit/donation-form Goal Bar [Coming soon!]: /edit/request-a-widget Analytics: /edit/analytics Givebutter Elements (Deprecated): Getting Started: /edit/elements-install Dynamic Elements: /edit/elements-dynamic-elements Coded Elements: Bubble: /edit/elements-bubble Button: /edit/elements-button Giving Form: /edit/elements-type-form Analytics: /edit/elements-analytics Events: Donation Events: /edit/elements-donation-events REST API: API Reference: https://docs.givebutter.com/reference ``` -------------------------------- ### Givebutter REST API Reference Source: https://docs.givebutter.com/reference/reference-getting-started/edit/request-a-widget Provides a link to the comprehensive REST API reference documentation for Givebutter, enabling programmatic access to Givebutter's features. ```APIDOC REST API: - API Reference: https://docs.givebutter.com/reference ``` -------------------------------- ### Givebutter Widgets Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-button This section outlines the available widgets for integration, including Donate Button, Donation Form, and a Goal Bar (coming soon). It serves as a starting point for understanding widget functionalities. ```APIDOC Widgets: - Donate Button: For adding donation buttons. - Donation Form: For embedding donation forms. - Goal Bar: A future feature for displaying fundraising goals. ``` -------------------------------- ### Givebutter Widgets Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/events Provides an overview of available Givebutter widgets, including Donate Button, Donation Form, and a Request a Widget option. Some widgets may be marked as 'Coming soon'. ```APIDOC Widgets: - Getting Started: /edit/widgets - Available Widgets: - Button: /edit/donate-button - Form: /edit/donation-form - Goal Bar [Coming soon!]: /edit/request-a-widget - Analytics: /edit/analytics ``` -------------------------------- ### Funds API Endpoints Source: https://docs.givebutter.com/reference/reference-getting-started/reference/authentication Endpoints for managing funds, including retrieving lists of funds, getting specific fund details, creating new funds, updating existing funds, and deleting funds. ```APIDOC Get Funds: GET /funds Get a Fund: GET /funds/{fund_id} Create a Fund: POST /funds Request Body: (Fund Object details) Update a Fund: PATCH /funds/{fund_id} Request Body: (Fund Object details) Delete a Fund: DELETE /funds/{fund_id} ``` -------------------------------- ### Campaign Members API Endpoints Source: https://docs.givebutter.com/reference/reference-getting-started/reference/authentication Endpoints for managing campaign members, including retrieving lists of members, getting individual member details, and deleting members from a campaign. ```APIDOC Get Members: GET /campaigns/{campaign_id}/members Get a Member: GET /campaigns/{campaign_id}/members/{member_id} Delete a Member: DELETE /campaigns/{campaign_id}/members/{member_id} ``` -------------------------------- ### Givebutter Elements (Deprecated) Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-analytics This section details the deprecated Givebutter Elements, including installation, dynamic elements, coded elements (Bubble, Button, Giving Form), analytics, and events. It's important to note that these elements are deprecated and may not be supported in future versions. ```APIDOC Deprecated Elements: - Installation Guide - Dynamic Elements - Coded Elements: - Bubble - Button - Giving Form - Analytics - Events: - Donation Events ``` -------------------------------- ### Givebutter API Reference Source: https://docs.givebutter.com/reference/reference-getting-started/edit/coded-elements Provides access to the full Givebutter API documentation, enabling advanced usage and fine-grained control over Givebutter features. This includes managing widgets, elements, and analytics. ```APIDOC API Reference: URL: https://docs.givebutter.com/reference Description: Comprehensive documentation for all Givebutter API endpoints and functionalities. Includes: - Widgets: Getting Started, Available Widgets (Button, Form, Goal Bar), Analytics - Givebutter Elements (Deprecated): Getting Started, Dynamic Elements, Coded Elements (Bubble, Button, Giving Form), Analytics, Events (Donation Events) ``` -------------------------------- ### Givebutter REST API Reference Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-bubble Provides a link to the comprehensive REST API reference for Givebutter, covering all available endpoints and functionalities. ```APIDOC REST API: - API Reference: https://docs.givebutter.com/reference ``` -------------------------------- ### Givebutter REST API Reference Source: https://docs.givebutter.com/reference/reference-getting-started/edit/analytics Provides access to the comprehensive REST API documentation for Givebutter, enabling developers to integrate Givebutter's functionality into their applications. ```APIDOC REST API Reference: https://docs.givebutter.com/reference ``` -------------------------------- ### Givebutter API Reference Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-donation-events Provides links to various sections of the Givebutter API documentation, including widgets, deprecated elements, and the main REST API reference. This serves as a starting point for developers looking to integrate Givebutter functionalities. ```APIDOC Widgets: Getting Started: /edit/widgets Available Widgets: Button: /edit/donate-button Form: /edit/donation-form Goal Bar [Coming soon!]: /edit/request-a-widget Analytics: /edit/analytics Givebutter Elements (Deprecated): Getting Started: /edit/elements-install Dynamic Elements: /edit/elements-dynamic-elements Coded Elements: Bubble: /edit/elements-bubble Button: /edit/elements-button Giving Form: /edit/elements-type-form Analytics: /edit/elements-analytics Events: Donation Events: /edit/elements-donation-events REST API: API Reference: https://docs.givebutter.com/reference ``` -------------------------------- ### Givebutter API Reference Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/donate-button This section outlines the structure and key areas of the Givebutter API documentation. It covers widgets, deprecated elements, and the main REST API reference. ```APIDOC Widgets: - Getting Started - Available Widgets (Button, Form, Goal Bar [Coming soon!]) - Analytics Givebutter Elements (Deprecated): - Getting Started - Dynamic Elements - Coded Elements (Bubble, Button, Giving Form) - Analytics - Events (Donation Events) REST API: - API Reference (https://docs.givebutter.com/reference) ``` -------------------------------- ### Givebutter REST API Reference Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-dynamic-elements Provides a link to the comprehensive REST API reference for Givebutter, enabling developers to integrate Givebutter's functionality into their applications. ```APIDOC REST API: - API Reference: https://docs.givebutter.com/reference ``` -------------------------------- ### Contacts API Endpoints Source: https://docs.givebutter.com/reference/reference-getting-started/reference/authentication Provides endpoints for managing contacts, including retrieving lists of contacts, getting specific contact details, creating new contacts, updating existing contacts, archiving, and restoring contacts. ```APIDOC Get Contacts: GET /contacts Get a Contact: GET /contacts/{contact_id} Create a Contact: POST /contacts Request Body: (Contact Object details) Update Contact: PATCH /contacts/{contact_id} Request Body: (Contact Object details) Archive a Contact: DELETE /contacts/{contact_id} Restore a Contact: PATCH /contacts/{contact_id}/restore ``` -------------------------------- ### Campaign Teams API Endpoints Source: https://docs.givebutter.com/reference/reference-getting-started/reference/authentication Endpoints for retrieving campaign teams and individual team details. ```APIDOC Get Teams: GET /campaigns/{campaign_id}/teams Get a Team: GET /teams/{team_id} ``` -------------------------------- ### Payouts API Endpoints Source: https://docs.givebutter.com/reference/reference-getting-started/reference/authentication Endpoints for retrieving payout information, including lists of payouts and details for individual payouts. ```APIDOC Get Payouts: GET /payouts Get a Payout: GET /payouts/{payout_id} ``` -------------------------------- ### Givebutter Widgets Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-bubble This section outlines the available widgets for Givebutter, including the Donate Button, Donation Form, and a Goal Bar which is noted as 'Coming soon!'. It also links to analytics. ```APIDOC Widgets: - Donate Button - Donation Form - Goal Bar [Coming soon!] - Analytics ``` -------------------------------- ### Givebutter REST API Reference Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-button Provides a link to the comprehensive REST API reference documentation for Givebutter. This is the primary resource for developers integrating with Givebutter's backend services. ```APIDOC REST API Reference: - Link: https://docs.givebutter.com/reference ``` -------------------------------- ### Givebutter Widgets Overview Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-dynamic-elements This section outlines the available widgets for Givebutter, including the Donate Button, Donation Form, and a Goal Bar which is noted as 'Coming soon!'. It also links to analytics. ```APIDOC Widgets: - Donate Button - Donation Form - Goal Bar [Coming soon!] - Analytics ``` -------------------------------- ### Givebutter REST API Reference Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-analytics Provides access to the comprehensive REST API reference for Givebutter, allowing developers to programmatically interact with Givebutter's features and data. ```APIDOC REST API Reference: - Comprehensive documentation for all API endpoints and functionalities. - Link: https://docs.givebutter.com/reference ``` -------------------------------- ### Givebutter Initialization and Event Handling Source: https://docs.givebutter.com/reference/reference-getting-started/docs/elements-install Demonstrates how to initialize the Givebutter library and register event listeners. The library is loaded asynchronously, making `setOptions` and `addEventListener` available immediately. Other functions require waiting for the 'ready' event. ```javascript window.Givebutter('setOptions', { option: 'value' }); window.Givebutter('addEventListener', 'eventName', function() { }); window.Givebutter(function(givebutter) { // Elements is ready and accessible via the givebutter variable (or window.Givebutter) }); ``` -------------------------------- ### Givebutter API Overview Source: https://docs.givebutter.com/reference/reference-getting-started/reference/reference-getting-started Provides general information about the Givebutter API, including its RESTful design, JSON data format, and regular updates to documentation. It also links to related documentation for authentication, errors, and pagination. ```APIDOC Givebutter API: - Architecture: RESTful - Data Format: JSON (requests and responses) - Related Documentation: - Authentication: /reference/authentication - Errors: /reference/errors - Pagination: /reference/pagination ``` -------------------------------- ### Givebutter Elements (Deprecated) Source: https://docs.givebutter.com/reference/reference-getting-started/edit/request-a-widget This section details the deprecated Givebutter Elements, covering installation, dynamic elements, coded elements (Bubble, Button, Giving Form), analytics, and events like donation events. ```APIDOC Givebutter Elements (Deprecated): - Getting Started - Dynamic Elements - Coded Elements: - Bubble - Button - Giving Form - Analytics - Events: - Donation Events ``` -------------------------------- ### Givebutter Elements (Deprecated) Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-dynamic-elements This section details the deprecated Givebutter Elements, covering installation, dynamic elements, coded elements (Bubble, Button, Giving Form), analytics, and events like donation events. ```APIDOC Givebutter Elements (Deprecated): - Getting Started - Dynamic Elements - Coded Elements: - Bubble - Button - Giving Form - Analytics - Events: - Donation Events ``` -------------------------------- ### Givebutter Elements (Deprecated) Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-bubble This section details the deprecated Givebutter Elements, including installation, dynamic elements, coded elements (Bubble, Button, Giving Form), and analytics. It also covers donation events. ```APIDOC Givebutter Elements (Deprecated): - Getting Started - Dynamic Elements - Coded Elements: - Bubble - Button - Giving Form - Analytics - Events: - Donation Events ``` -------------------------------- ### Givebutter Elements (Deprecated) Source: https://docs.givebutter.com/reference/reference-getting-started/edit/analytics This section details the deprecated Givebutter Elements, including installation, dynamic elements, coded elements (Bubble, Button, Giving Form), analytics, and events like donation events. ```APIDOC Givebutter Elements (Deprecated): - Getting Started: /edit/elements-install - Dynamic Elements: /edit/elements-dynamic-elements - Coded Elements: - Bubble: /edit/elements-bubble - Button: /edit/elements-button - Giving Form: /edit/elements-type-form - Analytics: /edit/elements-analytics - Events: - Donation Events: /edit/elements-donation-events ``` -------------------------------- ### Givebutter Elements (Deprecated) Source: https://docs.givebutter.com/reference/reference-getting-started/edit/elements-button This section details the deprecated Givebutter Elements, including installation, dynamic elements, coded elements (Bubble, Button, Giving Form), analytics, and events. It's important to note these are legacy features. ```APIDOC Givebutter Elements (Deprecated): - Installation: Guide for setting up elements. - Dynamic Elements: For creating dynamic UI components. - Coded Elements: - Bubble: Specific element for integration. - Button: Element for donation buttons. - Giving Form: Element for donation forms. - Analytics: For tracking element performance. - Events: - Donation Events: Handling donation-related events. ``` -------------------------------- ### Givebutter API Overview Source: https://docs.givebutter.com/reference/reference-getting-started/reference Provides general information about the Givebutter API, including its RESTful design, JSON data format, and regular updates to documentation. It also links to related documentation for authentication, errors, and pagination. ```APIDOC Givebutter API: - Architecture: RESTful - Data Format: JSON (requests and responses) - Related Documentation: - Authentication: /reference/authentication - Errors: /reference/errors - Pagination: /reference/pagination ```