Skip to content

greenpeace-cee/at.greenpeace.donutapp

Repository files navigation

CiviCRM DonutApp Integration

CircleCI

This extension connects CiviCRM with DonutApp by Formunauts.

The extension is licensed under AGPL-3.0.

Requirements

  • PHP v7.2+
  • CiviCRM (5.24+)

Installation (Web UI)

This extension has not yet been published for installation via the web UI.

Installation (CLI, Zip)

Sysadmins and developers may download the .zip file for this extension and install it with the command-line tool cv.

cd <extension-dir>
cv dl at.greenpeace.donutapp@https://github.com/greenpeace-cee/at.greenpeace.donutapp/archive/master.zip

Installation (CLI, Git)

Sysadmins and developers may clone the Git repo for this extension and install it with the command-line tool cv.

git clone https://github.com/greenpeace-cee/at.greenpeace.donutapp.git
cv en donutapp

Usage

To use the DonutApp API, you need client_id and client_secret, which will be provided by Formunauts.

To import petitions, use the DonutPetition.import API call.

To import donations, use the DonutDonation.import API call.

To import work shifts of fundraisers, use the FormunautsWorkshift.sync API call.

Campaigns used when creating entities can be specified through various means and are used in this precedence:

  • Via an optional/custom external_campaign_id field within the DonutApp API response
  • Via the donutapp_campaign_map setting, which maps DonutApp campaigns to CiviCRM campaigns. The mapping is stored as an array in the form of ['{donutapp_campaign_id}' => '{civicrm_campaign_id}'].
  • Via the campaign_id parameter passed to the import API

Webshop Order Types used when processing donations can be specified either by:

  • Using the donutapp_order_type_map setting, which maps membership type names to order type names. Example: {"Special_Membership_Type":"Special_Order_Type","default":"Fallback Order Type"}
  • Using a order_type field in the Donation payload, e.g. if the order type selection should be part of the donation form

Known Issues

  • Only recurring donations are supported