ProPeace/de.forumzfd.twinglecampaign
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

📓 add documentation

Browse source
This commit is contained in:
Marc Michalsky forumZFD 2021-04-11 19:55:59 +02:00
parent 88fb74bd6f
commit 0ba0674412
Signed by untrusted user who does not match committer: marc.koch
GPG key ID: 12406554CFB028B9
19 changed files with 172 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/Twingle_Campaign.md Normal file
View file

@ -0,0 +1,15 @@
# Twingle Campaign
The *Twingle Campaign* campaign type does, unlike the other campaign types (*Twingle Project* & *Twingle Event*), not
represent an entity on the Twingle side.
The *Twingle Campaign* is can be used to track the origin of a donation. In order to achieve this, it takes the URL of
it's *Twingle Project* parent campaign and adds a `cid` parameter to its end that will be sent to Twingle and back. With
the `cid` coming back from Twingle via API call to *TwingleDonation.submit* (provided by the **Twingle API** extension)
the donation can get assigned to the originally *Twingle Campaign*.
**Attention:** The *Twingle Campaign* must always be the child (or grandchild) of a *Twingle Project*.
You can use the *Twingle Campaign* url for example for newsletters or social media posts. The url will lead the users to
the Twingle donation form of the parent *Twingle Project* but thanks to the `cid`, the donation will be assigned to
the *Twingle Campaign*.