Skip to main content

Riseact Entities

Riseact provides several entities that allow non-profit organizations to manage their fundraising initiatives. In this guide, we will explore the different Riseact entities and how they work.

Campaigns​

Campaigns represent specific fundraising initiatives. Each campaign includes the donation form configuration (fields, amounts, donation type) and can be published across multiple channels.

Relationships:

  • Can be included in one or more projects
  • Has many checkouts
  • Has many donations

For more details, see the Campaigns Guide.

Projects​

Projects are aggregations of related campaigns. They allow you to organize campaigns in a structured way. There are two types: manual (hand-picked campaigns) and dynamic (campaigns filtered automatically through rules on tags or title).

Relationships:

  • Contains many campaigns (sortable)

For more details, see the Projects Guide.

Supporters​

Supporters are the donors registered within the organization. They are created (or associated with an existing profile) upon completion of a checkout. Each supporter has a complete profile with personal information and marketing consent preferences.

Relationships:

  • Has many donations
  • Has many payments (through donations)
  • Can be associated with many checkouts as the origin
  • Can have many custom fields of type supporter

Checkouts​

Checkouts are the donation sessions in which supporters make a donation for a campaign. They have two states: open (OPEN) and closed (CLOSED). Upon completion, they generate a donation, a payment (if immediate), and register or update the supporter.

Relationships:

  • Belongs to a campaign
  • Can be associated with a supporter (optional, set upon completion)
  • Contains at most one donation (OneToOne, optional)
  • Contains at most one payment (OneToOne, optional)
  • The supporter_custom_fields and donation_custom_fields fields capture the custom field values at the time of checkout

For more information, see the Checkouts Guide.

Donations​

Donations represent the contributions made by supporters. They can be of type oneoff (single) or recurring (monthly or yearly). The available states are: draft, pending, active, past_due, done, revoked.

Relationships:

  • Belongs to a campaign
  • Belongs to a supporter
  • Has many payments
  • Is associated with at most one checkout (OneToOne, optional)
  • Can have many custom fields of type donation

For a detailed guide, see the Donations Guide.

Payments​

Payments are the actual monetary transactions associated with a donation. They can be created automatically by gateways (Stripe, PayPal, Satispay, SumUp) or recorded manually. The available states are: pending, paid, refunded, failed.

Relationships:

  • Belongs to a donation
  • Belongs to a supporter

For a complete guide, see the Payments Guide.

Channels​

Channels represent the platforms on which campaigns are published, such as the website, Totem (Riseact Kiosk), the Riseact Together app, and installed external applications. Channels are not a separate entity: each campaign and payment method stores an array of channel IDs to indicate which channels it is active on.

For a complete guide, see the Channels Guide.

Custom Fields​

Custom fields let you extend supporter profiles and donations with custom fields defined by the organization. Each field has a type (text, boolean, select) and a unique key auto-generated from the name.

Relationships:

  • Definitions belong to an organization
  • Values are associated with a specific supporter or donation instance
  • Custom field keys can be included in a campaign's shown_fields and required_fields to display them in the donation form

For a complete guide, see the Custom Fields Guide.