Objects
AccessToken
The access token of a private application, to be sent as a bearer token when calling the API.
Fields
| Name | Description |
|---|---|
tokenString! | The token itself. Shown once, on creation or refresh. |
Activity
A task to do on a supporter or a donation, assigned to a staff member and marked as done once carried out.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the activity. |
createDateDateTime! | When the activity was created. |
updateDateDateTime! | When the activity was last modified. |
categoryActivityCategory! | Kind of task to carry out. |
deadlineDateDate | Day the task is due. Null when it has no deadline. |
doneDateDate | Day the task was carried out. Null while it is still open. |
noteString | Free-text note describing the task or its outcome. |
staffActivityStaff! | Staff member the task is assigned to. |
ActivityConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[ActivityEdge!]! | Items of this page, in the order defined by the query. |
ActivityEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeActivity! | The item itself. |
ActivityResponse
Result of an activity mutation: the activity on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
activityActivity | The activity as persisted after the mutation. Null when |
ActivityStaff
The staff member an activity is assigned to, reduced to what is needed to show them in a list.
Fields
| Name | Description |
|---|---|
idInt! | Identifier of the membership. |
nameString! | Display name of the staff member. |
emailString! | Email address of the staff member. |
Application
An OAuth2 application: a channel or an integration that talks to the API on behalf of an organization, such as the donation widget, a kiosk or a partner app.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the application. |
nameString! | Name of the application, shown when asking the organization to install it. |
descriptionString | What the application does, shown on its installation page. |
logoUrlString | URL of the logo of the application. |
typeApplicationType! | Kind of application: private, public or one of the applications of Riseact. |
appUrlString | URL the application is opened at once installed. |
installUrlString | URL the installation flow of the application starts at. |
authorNameString | Name of who publishes the application. |
authorHomepageUrlString | Site of who publishes the application. |
authorEmailString | Support address of who publishes the application. |
isEmbeddedBoolean! | Whether the application is shown inside the Riseact back-office instead of on its own site. |
permissions[StaffPermission!]! | Permissions the application asks the organization for. |
clientIdString! | OAuth2 client identifier of the application. |
clientSecretString! | OAuth2 client secret of the application. Treat it as a credential and never expose it to a browser. |
partnerString | Name of the agency publishing the application. Null for private apps and for the applications of Riseact. |
accessTokenAccessToken! | Access token of the application for this organization, for private apps that call the API without going through the OAuth2 flow. |
isInstalledBoolean! | Whether the organization has installed the application. |
AppMutation
Entry point of the admin API: everything an application can change in an organization.
Fields
| Name | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
articlesCreateArticlesResponse! | Publishes a post in one of the blogs of the site. Arguments
| ||||||||
articlesUpdateArticlesResponse! | Updates the fields of the post that are present in the input. Arguments
| ||||||||
articlesDeleteArticlesResponse! | Deletes the post. Arguments
| ||||||||
activityCreateActivityResponse! | Creates a task on a supporter or a donation. Arguments
| ||||||||
activityDoneActivityResponse! | Marks the task as carried out today. Arguments
| ||||||||
activityUndoneActivityResponse! | Reopens a task that had been marked as done. Arguments
| ||||||||
activityUpdateActivityResponse! | Updates the fields of the task that are present in the input. Arguments
| ||||||||
activityDeleteActivityResponse! | Deletes the task. Arguments
| ||||||||
blogsCreateBlogsResponse! | Creates a blog on the public site. Arguments
| ||||||||
blogsUpdateBlogsResponse! | Updates the fields of the blog that are present in the input. Arguments
| ||||||||
blogsDeleteBlogsResponse! | Deletes the blog together with its posts. Arguments
| ||||||||
campaignCreateCampaignResponse! | Creates a campaign together with its public page. Requires the Arguments
| ||||||||
campaignDuplicateCampaignResponse! | Creates a copy of the campaign, its form configuration and its cost examples. The copy starts hidden. Requires the Arguments
| ||||||||
campaignUpdateCampaignResponse! | Updates the fields of the campaign that are present in the input. Requires the Arguments
| ||||||||
campaignDeleteCampaignResponse! | Deletes the campaign. Fails when donations are already attached to it. Requires the Arguments
| ||||||||
campaignCommentCreateCampaignCommentResponse! | Attaches a comment to a donation. Requires the Arguments
| ||||||||
campaignCommentUpdateCampaignCommentResponse! | Moderates or edits a comment. Requires the Arguments
| ||||||||
campaignCommentDeleteCampaignCommentResponse! | Deletes the comment. Requires the Arguments
| ||||||||
peerCampaignCreatePeerCampaignResponse! | Opens a peer-to-peer page for a supporter on one of the campaigns that allow it. Requires the Arguments
| ||||||||
peerCampaignUpdatePeerCampaignResponse! | Updates the fields of the peer page that are present in the input. Requires the Arguments
| ||||||||
peerCampaignDeletePeerCampaignResponse! | Deletes the peer page. Requires the Arguments
| ||||||||
checkoutCreateCheckoutResponse! | Opens a checkout session and returns it, token included. Arguments
| ||||||||
checkoutUpdateCheckoutResponse! | Updates the fields of the session that are present in the input, as the donor advances through the form. Arguments
| ||||||||
checkoutCompleteCheckoutResponse! | Closes the session, creating the supporter and the donation out of the data it holds. Arguments
| ||||||||
checkoutRegisterPaymentCheckoutResponse! | Records against the session the payment collected by the gateway, and settles the resulting donation. Arguments
| ||||||||
checkoutSendRecoveryEmailCheckoutResponse! | Sends the donor an email with a link to resume the abandoned session. Arguments
| ||||||||
donationUpdateDonation! | Updates the editable fields of a donation. Requires the Arguments
| ||||||||
donationExportString! | Starts an asynchronous export of the donations matching the given domain and returns the email address the file will be sent to. Requires the Arguments
| ||||||||
donationReceiptSendBoolean! | Generates the tax receipt of the donation and sends it to the supporter. Returns whether the message was actually sent. Requires the Arguments
| ||||||||
donationRegisterPaymentDonationResponse! | Registers a payment collected outside Riseact against the donation, for example a bank transfer. Requires the Arguments
| ||||||||
donationImportImportRun! | Uploads a file of donations and starts an asynchronous import run, returning the run to poll for progress. Requires the Arguments
| ||||||||
donationRevokeDonation! | Revokes the pledge, stopping any future collection. Already revoked donations are returned unchanged. Requires the Arguments
| ||||||||
donationDeleteDonation! | Deletes the donation and returns the record as it was before deletion. Requires the Arguments
| ||||||||
mediaCreateMedia! | Uploads an image and returns it with its derived sizes. Arguments
| ||||||||
mediaDeleteMediaResponse! | Deletes an image. Records still pointing at it lose their picture. Arguments
| ||||||||
menuCreateMenuResponse! | Creates a navigation menu with its entries. Arguments
| ||||||||
menuUpdateMenuResponse! | Updates the menu and replaces its entries with the ones sent. Arguments
| ||||||||
menuDeleteMenuResponse! | Deletes the menu. A theme still calling its handle finds nothing. Arguments
| ||||||||
organizationUpdateOrganizationResponse! | Updates the profile, the contacts and the certificate settings of the organization. Arguments
| ||||||||
organizationUpdateLegalDataOrganizationResponse! | Updates the terms of service, the privacy policy and the default consents of the organization. Arguments
| ||||||||
terminalLocationCreateStripeTerminalLocation! | Creates a location card readers can be installed at. Arguments
| ||||||||
terminalLocationUpdateStripeTerminalLocation! | Updates the address of a location. Arguments
| ||||||||
terminalLocationDeleteVoid | Deletes a location. The readers installed there must be moved first. Arguments
| ||||||||
terminalRegisterStripeTerminal! | Pairs a card reader with the organization, using the code shown on its screen. Arguments
| ||||||||
terminalUpdateLabelStripeTerminal! | Renames a card reader. Arguments
| ||||||||
terminalDeleteString! | Unpairs a card reader and returns its identifier. Arguments
| ||||||||
terminalConnectionTokenCreateString! | Issues a short-lived token the kiosk application uses to talk to the card readers. Arguments
| ||||||||
pagesCreatePagesResponse! | Creates a static page on the public site. Arguments
| ||||||||
pagesUpdatePagesResponse! | Updates the fields of the page that are present in the input. Arguments
| ||||||||
pagesDeletePagesResponse! | Deletes the page. Arguments
| ||||||||
manualPaymentMethodCreatePaymentMethodResponse! | Creates a payment method collected outside Riseact. Arguments
| ||||||||
manualPaymentMethodUpdatePaymentMethodResponse! | Updates a manual payment method. Arguments
| ||||||||
manualPaymentMethodDeletePaymentMethodResponse! | Deletes a manual payment method. Payments already collected with it are left untouched. Arguments
| ||||||||
paymentExportString! | Starts an asynchronous export of the payments matching the given domain and returns the email address the file will be sent to. Arguments
| ||||||||
paymentUpdatePaymentResponse! | Corrects the editable fields of a payment. Arguments
| ||||||||
paymentRefundPaymentResponse! | Refunds the payment on the gateway that collected it and records the refund. Arguments
| ||||||||
satispayPaymentCreateSatispayPaymentResponse! | Opens a Satispay payment for the checkout session and returns what the donor needs to pay it. Arguments
| ||||||||
projectCreateProjectResponse! | Creates a project together with its public page. Arguments
| ||||||||
projectUpdateProjectResponse! | Updates the fields of the project that are present in the input. Arguments
| ||||||||
projectUpdateItemsProjectResponse! | Replaces the campaigns listed in the project, in the given order. Only for projects listed by hand. Arguments
| ||||||||
projectRemoveItemProjectResponse! | Removes one campaign from a project listed by hand. Arguments
| ||||||||
projectDeleteProjectResponse! | Deletes the project. The campaigns it gathers are left untouched. Arguments
| ||||||||
supporterCreateSupporter! | Creates a supporter. Requires the Arguments
| ||||||||
supporterLeadCreateSupporter! | Creates a supporter as a lead, i.e. a contact acquired before any donation. Requires the Arguments
| ||||||||
supporterUpdateSupporter! | Updates the fields of a supporter that are present in the input. Requires the Arguments
| ||||||||
supporterDeleteSupporter! | Deletes the supporter and returns the record as it was before deletion. Requires the Arguments
| ||||||||
supporterSendTaxCertificateSupporter! | Generates the yearly tax certificate of the supporter and delivers it over the chosen channel. Requires the Arguments
| ||||||||
supporterImportImportRun! | Uploads a file of supporters and starts an asynchronous import run, returning the run to poll for progress. Requires the Arguments
| ||||||||
supporterBulkTagsBoolean! | Adds or removes the given labels on every supporter matching the filters. Requires the Arguments
| ||||||||
supporterExportString! | Starts an asynchronous export of the supporters matching the given domain and returns the email address the file will be sent to. Requires the Arguments
| ||||||||
supporterMergeSupporter! | Merges the duplicate supporters into the master one, moving their donations and history, and applies the given data to the result. Requires the Arguments
| ||||||||
supporterSetPrivacySupporterResponse! | Records a consent on the supporter, replacing any previous value for the same privacy definition. Requires the Arguments
| ||||||||
supporterRemovePrivacySupporterResponse! | Removes the consent identified by the given code from the supporter. Requires the Arguments
| ||||||||
segmentCreateSegmentResponse! | Saves a set of filters as a segment. Arguments
| ||||||||
segmentUpdateSegmentResponse! | Updates the name or the filters of a segment. Arguments
| ||||||||
segmentDeleteSegmentResponse! | Deletes a segment. Arguments
| ||||||||
stripeActivateStripeAccount! | Creates the Stripe connected account of the organization, or returns the one it already has. | ||||||||
stripeGenerateOnboardingLinkStripeLink! | Opens a link to the Stripe onboarding, where the organization submits the details Stripe needs to let it take payments. | ||||||||
stripeGenerateDashboardLinkStripeLink! | Opens a link to the Stripe dashboard of the connected account. | ||||||||
stripeCheckoutIntentCreateStripeCheckoutResponse! | Opens a Stripe payment for the checkout session and returns the intent for the browser to confirm. Arguments
| ||||||||
stripeTerminalCheckoutIntentCreateStripeCheckoutResponse! | Opens a Stripe payment for the checkout session, to be collected on a card reader instead of in a browser. Arguments
| ||||||||
sumupAccountCreateSumUpAccount! | Connects a SumUp merchant to the organization. Arguments
| ||||||||
sumupAccountUpdateSumUpAccount! | Changes the SumUp merchant connected to the organization. Arguments
| ||||||||
redirectsCreateRedirectResponse! | Creates a redirect on the public site. Arguments
| ||||||||
redirectsUpdateRedirectResponse! | Updates the path or the destination of a redirect. Arguments
| ||||||||
redirectsDeleteRedirectResponse! | Deletes the redirect, so the old address stops being forwarded. Arguments
| ||||||||
customfieldDefinitionCreateCustomFieldDefinitionResponse! | Adds a custom field to one kind of record. Arguments
| ||||||||
customfieldDefinitionUpdateCustomFieldDefinitionResponse! | Updates the label, the hint, the options or the position of a custom field. Arguments
| ||||||||
customfieldDefinitionDeleteCustomFieldDefinitionResponse! | Deletes a custom field definition together with the values recorded under it. Arguments
| ||||||||
privacyDefinitionCreatePrivacyDefinitionResponse! | Adds a consent to the ones the organization asks donors for. Arguments
| ||||||||
privacyDefinitionUpdatePrivacyDefinitionResponse! | Updates a consent definition. Consents already recorded on supporters are left untouched. Arguments
| ||||||||
privacyDefinitionDeletePrivacyDefinitionResponse! | Deletes a consent definition. Arguments
|
AppQuery
Entry point of the admin API: everything an application can read from an organization.
Fields
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
activitiesActivityConnection! | Paginated list of the activities of the organization. Arguments
| ||||||
activityActivity! | A single activity by id. Arguments
| ||||||
articlesArticleConnection! | Paginated list of the blog posts of the organization. Arguments
| ||||||
articleArticle! | A single blog post by id. Arguments
| ||||||
blogsBlogConnection! | Paginated list of the blogs of the organization. Arguments
| ||||||
blogBlog! | A single blog by id. Arguments
| ||||||
campaignsCampaignConnection! | Paginated list of the campaigns of the organization. Requires the Arguments
| ||||||
campaignCampaign! | A single campaign by id. Requires the Arguments
| ||||||
campaignTagsStrConnection! | Paginated list of the labels used on campaigns, for autocompletion and filtering. Requires the Arguments
| ||||||
campaignCommentsCampaignCommentConnection! | Paginated list of the comments left by donors, whatever their moderation state. Requires the Arguments
| ||||||
campaignCommentCampaignComment! | A single comment by id. Requires the Arguments
| ||||||
peerCampaignsPeerCampaignConnection! | Paginated list of the peer-to-peer pages of the organization. Requires the Arguments
| ||||||
peerCampaignPeerCampaign! | A single peer-to-peer page by id. Requires the Arguments
| ||||||
checkoutsCheckoutConnection! | Paginated list of the checkout sessions of the organization. Arguments
| ||||||
checkoutsAbandonedCheckoutConnection! | Paginated list of the sessions the donor left open without completing them, the ones a recovery email can be sent for. Arguments
| ||||||
checkoutsAdminGeneratedCheckoutConnection! | Paginated list of the promises, i.e. the sessions opened by an operator for a donation to be paid later. Arguments
| ||||||
checkoutCheckout! | A single checkout session by token. Arguments
| ||||||
donationsDonationConnection! | Paginated list of the donations of the organization, newest first. Requires the Arguments
| ||||||
donationDonation! | A single donation by id. Requires the Arguments
| ||||||
donationTagsStrConnection! | Paginated list of the labels used on donations, for autocompletion and filtering. Requires the Arguments
| ||||||
importRuns[ImportRun!]! | Import runs of the organization, newest first. Requires the | ||||||
importRunImportRun | A single import run by id. Requires the Arguments
| ||||||
mediaMediaConnection! | Paginated list of the images uploaded by the organization, newest first. Arguments
| ||||||
mediaSingleMedia! | A single image by id. Arguments
| ||||||
menus[Menu!]! | Navigation menus of the site. | ||||||
menuMenu! | A single menu by id. Arguments
| ||||||
menuByHandleMenu! | A single menu by the handle the theme calls it by. Arguments
| ||||||
organizations[Organization!]! | Organizations the signed-in user is staff of. Arguments
| ||||||
organizationOrganization! | The organization the request is addressed to, resolved from the host or from the access token. | ||||||
ownerStaff! | Staff member owning the organization. | ||||||
pagesPageConnection! | Paginated list of the static pages of the site. Arguments
| ||||||
pagePage! | A single page by id. Arguments
| ||||||
paymentMethods[PaymentMethod!]! | Every payment method available to the organization, gateways and manual methods alike. | ||||||
manualPaymentMethods[PaymentMethod!]! | Only the payment methods collected outside Riseact. | ||||||
manualPaymentMethodPaymentMethod! | A single manual payment method by id. Arguments
| ||||||
paymentsPaymentConnection! | Paginated list of the payments of the organization, newest first. Arguments
| ||||||
paymentPayment! | A single payment by id. Arguments
| ||||||
projectsProjectConnection! | Paginated list of the projects of the organization. Arguments
| ||||||
projectProject! | A single project by id. Arguments
| ||||||
supportersSupporterConnection! | Paginated list of the supporters of the organization. Requires the Arguments
| ||||||
supporterSupporter! | A single supporter by id. Requires the Arguments
| ||||||
supporterTagsStrConnection! | Paginated list of the labels used on supporters, for autocompletion and filtering. Requires the Arguments
| ||||||
segmentsSegmentConnection! | Paginated list of the saved segments of the organization. Arguments
| ||||||
segmentSegment! | A single segment by id. Arguments
| ||||||
terminalLocations[StripeTerminalLocation!]! | Locations card readers are installed at. Arguments
| ||||||
terminalLocationStripeTerminalLocation! | A single location by identifier. Arguments
| ||||||
terminals[StripeTerminal!]! | Card readers paired with the organization. | ||||||
terminalsByLocation[StripeTerminal!]! | Card readers installed at the given location. Arguments
| ||||||
terminalStripeTerminal! | A single card reader by identifier. Arguments
| ||||||
stripeStripeAccount | The Stripe account connected to the organization. Null when none is connected. | ||||||
stripeCustomerCards[StripeCard!]! | Cards saved by the given Stripe customer. Arguments
| ||||||
sumupAccountSumUpAccount | The SumUp account connected to the organization. Null when none is connected. | ||||||
redirectsRedirectConnection! | Paginated list of the redirects of the site. Arguments
| ||||||
redirectRedirect! | A single redirect by id. Arguments
| ||||||
customfieldDefinitions[CustomFieldDefinition!]! | Custom fields defined by the organization, in the order they are shown. Arguments
| ||||||
customfieldDefinitionCustomFieldDefinition! | A single custom field definition by id. Arguments
| ||||||
privacyDefinitionsPrivacyDefinitionConnection! | Paginated list of the consents the organization asks donors for. Arguments
| ||||||
privacyDefinitionPrivacyDefinition! | A single consent definition by id. Arguments
|
Article
A post published in one of the blogs of the public site.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the document inside the organization. |
titleString! | Title of the page, used as its heading and in listings. |
contentString | Body of the page, as HTML. |
visibilityWebDocumentVisibility! | Whether the page is public, reachable only by direct link, or hidden. |
slugString! | URL segment identifying the page inside the site. Unique per organization. |
urlString! | Absolute URL of the page on the public site. |
seoTitleString | Title used in the |
templateString | Name of the theme template rendering the page. Empty to use the default one for this kind of document. |
seoDescriptionString | Meta description used by search engines and link previews. |
createDateDateTime! | When the document was created. |
updateDateDateTime! | When the document was last modified. |
sitefrontUrlString! | Absolute URL of the post on the public site. |
blogBlog! | Blog the post belongs to. |
coverMedia | Cover image of the post. Null when none was set. |
ArticleConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[ArticleEdge!]! | Items of this page, in the order defined by the query. |
ArticleEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeArticle! | The item itself. |
ArticlesResponse
Result of an article mutation: the post on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
articleArticle | The post as persisted after the mutation. Null when |
Blog
A blog of the public site: the page listing its posts.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the document inside the organization. |
titleString! | Title of the page, used as its heading and in listings. |
contentString | Body of the page, as HTML. |
visibilityWebDocumentVisibility! | Whether the page is public, reachable only by direct link, or hidden. |
slugString! | URL segment identifying the page inside the site. Unique per organization. |
urlString! | Absolute URL of the page on the public site. |
seoTitleString | Title used in the |
templateString | Name of the theme template rendering the page. Empty to use the default one for this kind of document. |
seoDescriptionString | Meta description used by search engines and link previews. |
createDateDateTime! | When the document was created. |
updateDateDateTime! | When the document was last modified. |
sitefrontUrlString! | Absolute URL of the blog on the public site. |
coverMedia | Cover image of the blog. Null when none was set. |
BlogConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[BlogEdge!]! | Items of this page, in the order defined by the query. |
BlogEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeBlog! | The item itself. |
BlogsResponse
Result of a blog mutation: the blog on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
blogBlog | The blog as persisted after the mutation. Null when |
Campaign
A fundraising campaign: the public page donors give to, together with the configuration of its donation form (amounts, frequencies, fields and payment methods).
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the campaign inside the organization. |
titleString! | Title of the page, used as its heading and in listings. |
contentString | Body of the page, as HTML. |
visibilityWebDocumentVisibility! | Whether the page is public, reachable only by direct link, or hidden. |
slugString! | URL segment identifying the page inside the site. Unique per organization. |
urlString! | Absolute URL of the page on the public site. |
seoTitleString | Title used in the |
templateString | Name of the theme template rendering the page. Empty to use the default one for this kind of document. |
seoDescriptionString | Meta description used by search engines and link previews. |
createDateDateTime! | When the campaign was created. |
updateDateDateTime! | When the campaign was last modified. |
typeCampaignType! | Kind of campaign, which decides how it is presented and collected. |
goalFloat | Amount the campaign aims to raise. Meaningful only when |
noteString | Free-text note attached by the operator. Internal, never shown on the public page. |
tags[String!]! | Free-form labels attached to the campaign, used for filtering and reporting. |
allowPeerToPeerBoolean | Whether supporters may open their own peer-to-peer fundraising page for this campaign. |
isGoalEnabledBoolean! | Whether the goal and its progress bar are shown on the public page. |
costExamples[CostExample!]! | Concrete things the donor can choose to fund, instead of giving a free amount. |
excludedChannels[Int!]! | Identifiers of the applications (channels) the campaign must not be offered on. |
excludedPaymentMethods[Int!]! | Identifiers of the payment methods that must not be offered on this campaign, even if enabled for the organization. |
thankyouTemplateString | Name of the theme template rendering the thank-you page shown after a donation. Empty to use the default one. |
receiptNotificationIdInt | Identifier of the notification used to send the receipt for donations to this campaign. Null to use the default one of the organization. |
hasOneOffBoolean! | Whether the form offers one-off donations. |
hasSubscriptionBoolean! | Whether the form offers recurring donations. |
hasSubscriptionCustomOptionsBoolean! | Whether recurring donations use their own amounts and limits instead of reusing the one-off ones. |
allowCustomAmountBoolean! | Whether the donor may type a one-off amount of their choice, on top of the suggested ones. |
allowCustomSubscriptionAmountBoolean! | Whether the donor may type a recurring amount of their choice, on top of the suggested ones. |
defaultAmountFloat | One-off amount preselected on the form. |
defaultSubscriptionAmountFloat | Recurring amount preselected on the form. |
minAmountFloat | Smallest one-off amount accepted. |
maxAmountFloat | Largest one-off amount accepted. |
minSubscriptionAmountFloat | Smallest recurring amount accepted. |
maxSubscriptionAmountFloat | Largest recurring amount accepted. |
asks[Float!]! | Suggested one-off amounts, shown as buttons on the form. |
asksSubscription[Float!]! | Suggested recurring amounts, shown as buttons on the form. |
shownFields[String!]! | Names of the supporter fields displayed on the donation form. |
requiredFields[String!]! | Names of the supporter fields the donor must fill in. Always a subset of |
privacyNoteString | Text shown next to the consent checkboxes on the donation form. |
sitefrontUrlString! | Absolute URL of the campaign page on the public site. |
customfields[CustomField!]! | Values of the custom fields defined by the organization for campaigns. |
privacyFields[PrivacyDefinition!]! | Privacy definitions whose consent is asked on the donation form, in the order they are shown. |
coverMedia | Cover image of the campaign page. Null when none was set. |
CampaignComment
A message left by a donor when giving, shown on the campaign or peer page once approved.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the comment. |
createDateDateTime! | When the comment was left. |
updateDateDateTime! | When the comment was last modified or moderated. |
messageString! | Text written by the donor. |
statusCampaignCommentStatus! | Moderation state of the comment. Only approved comments are shown publicly. |
supporterSupporter! | Supporter who wrote the comment. |
campaignCampaign! | Campaign the comment was left on. |
publicBoolean! | Whether the donor agreed to have the comment shown publicly. |
anonymousBoolean! | Whether the comment must be shown without the name of the donor. |
peerCampaignPeerCampaign | Peer page the comment was left on. Null when it was left on the campaign itself. |
CampaignCommentConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[CampaignCommentEdge!]! | Items of this page, in the order defined by the query. |
CampaignCommentEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeCampaignComment! | The item itself. |
CampaignCommentResponse
Result of a comment mutation: the comment on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
commentCampaignComment | The comment as persisted after the mutation. Null when |
CampaignConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[CampaignEdge!]! | Items of this page, in the order defined by the query. |
CampaignEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeCampaign! | The item itself. |
CampaignResponse
Result of a campaign mutation: the campaign on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
campaignCampaign | The campaign as persisted after the mutation. Null when |
Checkout
A donation funnel session: the snapshot of what the donor entered on the form, kept under a token until the donation and the payment are created. Also used for promises, i.e. donations pledged now and paid later.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the checkout inside the organization. |
tokenString! | Opaque token identifying the session. It is what the donation form and the payment pages address the checkout by. |
stateCheckoutState! | State of the session. |
errorMessageString | Message of the last error met while completing the session, for example a refusal from the gateway. Null when nothing failed. |
completedDateDateTime | When the session was completed and turned into a donation. Null while it is still open. |
supporterBusinessNameString | Legal name of the company, family or group, as entered on the form. |
supporterFirstNameString | Given name entered on the form. |
supporterLastNameString | Family name entered on the form. |
supporterTypeString | Nature of the supporter, as chosen on the form. |
supporterEmailString | Email address entered on the form. |
supporterPhoneString | Landline number entered on the form. |
supporterMobileString | Mobile number entered on the form. |
supporterSexString | Gender chosen on the form. |
supporterDateOfBirthDate | Date of birth entered on the form. |
supporterPlaceOfBirthString | Place of birth entered on the form. |
supporterSsnString | National tax identifier entered on the form, needed to issue a deductible receipt. |
supporterVatString | VAT number entered on the form. |
supporterAddressString | Street address entered on the form. |
supporterAddress2String | Second address line entered on the form. |
supporterCityString | City entered on the form. |
supporterLocalityString | Locality or province entered on the form. |
supporterCountryString | Country entered on the form. |
supporterPostalCodeString | Postal code entered on the form. |
supporterPrivacyBoolean | Whether the donor accepted the privacy policy on the form. |
supporterEmailMarketingBoolean | Whether the donor consented to marketing by email. |
supporterPhoneMarketingBoolean | Whether the donor consented to being contacted for marketing by phone. |
supporterPrivacyValuesBoolean | Whether the per-purpose consents asked by the campaign were accepted. |
donationAmountFloat | Amount chosen by the donor. |
donationFrequencyFrequency | Frequency chosen by the donor: a one-off gift or a recurring pledge. |
costExampleQuantityInt! | How many units of the chosen cost example the donation covers. Zero when no cost example was picked. |
recoveryMailSentDateDateTime | When the reminder for the abandoned session was sent. Null when none was sent. |
applicationMetadataJSON | Free-form JSON the application that opened the session attached to it, carried through to the donation. |
tags[String!]! | Labels to attach to the donation once the session is completed. |
createDateDateTime! | When the session was opened. |
updateDateDateTime! | When the session was last modified. |
supporterFullnameString! | Display name built from the personal or business name entered on the form. |
campaignCampaign! | Campaign the session collects for. |
peerCampaignPeerCampaign | Peer-to-peer page the session was opened from. Null when it was opened on the campaign itself. |
enabledPaymentMethods[PaymentMethod!]! | Payment methods the donor may pay with, given the campaign, the channel and the chosen frequency. |
supporterSupporter | Supporter the session is attached to, when they were recognised or already created. Null otherwise. |
donationDonation | Donation created by the session. Null while it has not been completed. |
checkoutUrlString! | Absolute URL of the donation form for this session, to be sent to the donor to resume or pay it. |
applicationApplication | Application (channel) that opened the session, such as the donation widget or a kiosk. Null when unknown. |
CheckoutConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[CheckoutEdge!]! | Items of this page, in the order defined by the query. |
CheckoutEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeCheckout! | The item itself. |
CheckoutResponse
Result of a checkout mutation: the session on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
checkoutCheckout | The session as persisted after the mutation. Null when |
CostExample
A concrete thing a given amount pays for, offered to the donor as an alternative to a free amount (for example: 25 EUR feeds a child for a month).
Fields
| Name | Description |
|---|---|
amountFloat! | Amount that buys one unit of the example, in the currency of the organization. |
nameString! | Short label of the example, shown on the donation form. |
descriptionString! | Longer explanation of what the amount pays for. |
uuidString! | Stable identifier of the example inside the campaign. |
monitorQuantityBoolean! | Whether the available quantity is tracked and the example stops being offered once exhausted. |
quantityInt! | Total number of units offered. Meaningful only when |
availableQuantityInt! | Units still available. Meaningful only when |
imageMedia | Picture shown next to the example. Null when none was set. |
Country
A country, as listed by the ISO 3166-1 standard.
Fields
| Name | Description |
|---|---|
nameString! | English name of the country. |
codeString! | Two-letter ISO 3166-1 code of the country. |
CustomField
The value of a custom field on a single record.
Fields
| Name | Description |
|---|---|
keyString! | Key of the definition the value belongs to. |
typeCustomFieldType! | Type of the value, copied from the definition. |
valueString | The value itself, always serialised as a string. Null when the field was left empty. |
metaCustomFieldDefinition! | The definition the value belongs to, with its label, its options and its position. |
CustomFieldDefinition
A field added by the organization to one kind of record, on top of the ones Riseact provides.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the definition. |
entityCustomFieldEntity! | Kind of record the field is defined on. |
nameString! | Label shown to operators and donors. |
keyString! | Stable key the values are written and read under. Generated from the name and never changes. |
descriptionString | Hint shown under the field. |
typeCustomFieldType! | Type of value the field holds. |
positionInt! | Order the field is shown in, ascending. |
options[String!] | Values to choose from. Set only on fields of a choice type. |
archivedBoolean! | Whether the field is archived. Archived fields keep their values but are no longer offered. |
CustomFieldDefinitionResponse
Result of a custom field mutation: the definition on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
customFieldDefinitionCustomFieldDefinition | The definition as persisted after the mutation. Null when |
DisplayedPartner
The agency the organization is managed by, as shown in the back-office.
Fields
| Name | Description |
|---|---|
nameString! | Name of the partner. |
logoMedia | Logo of the partner. Null when none was uploaded. |
Donation
A donation pledge: the commitment of a supporter to give an amount, once or on a recurring schedule. The money actually collected is tracked by the related Payment records.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the donation inside the organization. |
codeString! | Human-readable identifier of the donation, shown in the back-office and in receipts. Empty on donations created before codes were introduced. |
stateDonationState! | Lifecycle state of the pledge. Recurring pledges stay |
amountFloat! | Amount pledged for a single instalment, in the currency of the organization. Not the total collected: use |
frequencyFrequency | How often the pledge is collected. |
noteString | Free-text note attached by the operator. Internal, never shown to the supporter. |
completedDateDateTime | When the pledge was fully honoured, i.e. moved to the |
createDateDateTime! | When the donation record was created. |
updateDateDateTime! | When the donation record was last modified. |
deviceString | Device or channel the donation originated from. Currently always empty and kept for backward compatibility. |
tags[String!]! | Free-form labels attached to the donation, used for filtering and segmentation. |
isPublicBoolean! | Whether the donation may be shown publicly, for example in the donor wall of a peer campaign. |
costExampleQuantityInt! | How many units of the chosen |
externalRefString | Identifier of the donation in the external system it was imported from, used to deduplicate rows on re-import. Null for donations created in Riseact. |
importRunImportRun | The import run that created this donation, when it came from a file import. Null for donations created in Riseact. |
receiptUrlString | Signed URL of the tax receipt issued for this donation. Null when no receipt has been generated. |
campaignCampaign! | Campaign the donation was given to. |
peerCampaignPeerCampaign | Peer-to-peer fundraising page the donation came through. Null for donations collected on the campaign itself. |
costExampleCostExample | Cost example the donor picked when giving, i.e. the concrete item their money funds. Null when the campaign offers none or none was chosen. |
paymentMethodPaymentMethod | Payment method used to collect the pledge. Null when no method was assigned, for example on imported or draft donations. |
supporterSupporter! | Supporter who made the pledge. |
checkoutCheckout | Checkout session the donation was created from. Null for donations created in the back-office or by import. |
totalPaymentsInt! | Number of payments recorded against this pledge, whatever their state. |
totalPaidFloat! | Sum of the payments successfully collected for this pledge, in the currency of the organization. |
customfields[CustomField!]! | Values of the custom fields defined by the organization for donations. |
DonationConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[DonationEdge!]! | Items of this page, in the order defined by the query. |
DonationEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeDonation! | The item itself. |
DonationResponse
Result of a donation mutation: the donation on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
donationDonation | The donation as persisted after the mutation. Null when |
ImportFailedRow
A row of the imported file that could not be processed, kept so the operator can correct it and import it again.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the failed row. |
rowNumberInt! | Position of the row in the uploaded file, header excluded. |
errorCodeImportRowErrorCode! | Why the row could not be imported. |
errorMessageString | Details of the error, when the code alone is not enough. |
stageImportStage! | Step of the import the row failed at. |
rawDataJSON! | The row as read from the file, column by column. |
ImportRun
One upload of a file and its processing: what it created, what it could not, and how it ended.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the run. |
kindImportKind! | What the run imports: supporters, donations or payments. |
stateImportRunState! | State of the run. Poll it to follow the progress of an upload. |
filenameString | Name of the uploaded file. |
rowsTotalInt! | Number of rows read from the file. |
supportersCreatedInt! | Supporters created by the run. |
donationsCreatedInt! | Donations created by the run. |
paymentsCreatedInt! | Payments created by the run. |
rowsFailedInt! | Rows the run could not import. |
attemptsInt! | How many times the run was attempted, retries included. |
fileHashString | Digest of the uploaded file, used to recognise a file already imported. |
taskIdString | Identifier of the background task processing the run. |
errorCodeImportRunError | Why the run failed as a whole. Null when it did not. |
errorMessageString | Details of the failure of the run. Null when it did not fail. |
createDateDateTime! | When the file was uploaded. |
updateDateDateTime! | When the run was last modified. |
labelString! | Human-readable name of the run, built from its kind and its file. |
staffNameString | Name of the staff member who uploaded the file. Null when the run was not started by a person. |
failedRows[ImportFailedRow!]! | Rows the run could not import, with the reason for each. |
Media
An image uploaded by the organization, with the derived sizes used across the back-office and the public site.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the media. |
nameString! | File name of the uploaded image. |
urlString! | URL of the image at its original size. |
heightInt! | Height of the original image, in pixels. |
widthInt! | Width of the original image, in pixels. |
sizeInt! | Weight of the original file, in bytes. |
createDateString! | When the image was uploaded, as an ISO 8601 string. |
altString! | Alternative text of the image, for accessibility and search engines. |
squareString! | URL of the square thumbnail of the image. |
smallString! | URL of the small version of the image. |
mediumString! | URL of the medium version of the image. |
MediaConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[MediaEdge!]! | Items of this page, in the order defined by the query. |
MediaEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeMedia! | The item itself. |
MediaResponse
Result of a media mutation: the image on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
mediaMedia | The image as persisted after the mutation. Null when |
Menu
A navigation menu of the public site, addressed by its handle from the theme.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the menu. |
nameString! | Name of the menu, shown in the back-office. |
handleString! | Stable handle the theme calls the menu by, for example |
items[MenuItem!]! | Entries of the menu, in the order they are shown. |
MenuItem
One entry of a navigation menu.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the entry. |
labelString! | Text shown in the menu. |
linkString! | Address the entry points at, resolved against the site for internal destinations. |
typeMenuItemType! | What the entry points at. |
MenuResponse
Result of a menu mutation: the menu on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
menuMenu | The menu as persisted after the mutation. Null when |
Organization
The tenant: a non-profit collecting donations on Riseact, with its own data, branding, public site and billing.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the organization. |
referenceString! | Stable code identifying the organization across Riseact services. |
nameString! | Name of the organization, shown to donors. |
currencyCurrencies! | Currency donations are collected in. |
domainString! | Domain the public site of the organization answers on. |
contactEmailString | Email address donors are invited to write to. |
senderEmailString | Address the notifications of the organization are sent from. Requires the DNS checks in |
legalNameString | Registered name of the organization, used on receipts and invoices. |
isInvoiceRequiredBoolean | Whether the organization needs an invoice for what it is billed. |
vatString | VAT number of the organization. |
vatExchangeString | Code or address the electronic invoices of the organization must be delivered to. |
taxIdentificationNumberString | Tax identifier of the organization, printed on the receipts issued to donors. |
contactPhoneString | Phone number donors are invited to call. |
addressLine1String | Street address of the registered office. |
addressLine2String | Second address line of the registered office. |
cityString | City of the registered office. |
stateString | State or province of the registered office. |
postalCodeString | Postal code of the registered office. |
countryCountry | Country of the registered office. |
tosString | Terms of service shown on the public site and on the donation forms. |
consentScopes[String!]! | Codes of the consents the organization asks donors for by default. |
privacyPolicyString | Privacy policy shown on the public site and on the donation forms. |
baseSitefrontUrlString! | URL of the public site on the Riseact domain, which stays reachable whatever custom domain is configured. |
planTypeBillingPlanType | Subscription plan the organization is on. Null when it has no subscription yet. |
annualCertificateAutoSendBoolean! | Whether the yearly tax certificates are sent to supporters automatically. |
annualCertificateSendMonthInt! | Month of the year the certificates are sent in, as a number from 1 to 12. |
annualCertificateSendDayInt! | Day of the month the certificates are sent on. |
annualCertificateLastSentYearInt | Year the certificates were last sent for. Null when they were never sent. |
onboardingStatusOnboardingStatus! | How far the organization got in setting up its account. |
sitefrontUrlString! | Absolute URL of the public site, custom domain included when one is configured. |
logoMedia | Logo of the organization, used on the public site and in notifications. Null when none was uploaded. |
displayedPartnerDisplayedPartner | Agency managing the organization, when it is managed by one. |
senderEmailStatusOrganizationSenderEmailStatus! | Result of the DNS checks on the sender domain, with the records still to be added. |
ownerUser! | User owning the organization, i.e. the one billing and ownership are attached to. |
jwtPassKeyString! | Short-lived token that authenticates the organization against the analytics API. Valid for 30 days. |
OrganizationResponse
Result of an organization mutation: the organization on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
organizationOrganization | The organization as persisted after the mutation. Null when |
OrganizationSenderEmailStatus
Result of the DNS checks on the domain the organization sends its emails from. Everything must be verified before Riseact sends on its behalf.
Fields
| Name | Description |
|---|---|
spfBoolean! | Whether the SPF record of the sender domain is in place. |
spfValueString | SPF record to add to the DNS of the sender domain. Null once it is in place. |
dkimBoolean! | Whether the DKIM record of the sender domain is in place. |
dkimValueString | DKIM record to add to the DNS of the sender domain. Null once it is in place. |
verifiedBoolean! | Whether the sender address itself was verified. |
verificationStringString | Record to add to the DNS to verify the sender address. Null once verified. |
readyToSendBoolean | Whether every check passed and Riseact can send email on behalf of the organization. |
Page
A static page of the public site, such as who we are or how to reach us.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the document inside the organization. |
titleString! | Title of the page, used as its heading and in listings. |
contentString | Body of the page, as HTML. |
visibilityWebDocumentVisibility! | Whether the page is public, reachable only by direct link, or hidden. |
slugString! | URL segment identifying the page inside the site. Unique per organization. |
urlString! | Absolute URL of the page on the public site. |
seoTitleString | Title used in the |
templateString | Name of the theme template rendering the page. Empty to use the default one for this kind of document. |
seoDescriptionString | Meta description used by search engines and link previews. |
createDateDateTime! | When the document was created. |
updateDateDateTime! | When the document was last modified. |
sitefrontUrlString! | Absolute URL of the page on the public site. |
coverMedia | Cover image of the page. Null when none was set. |
PageConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[PageEdge!]! | Items of this page, in the order defined by the query. |
PageEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodePage! | The item itself. |
PageInfo
State of a paginated list: whether there is more to fetch, and the cursors to fetch it with.
Fields
| Name | Description |
|---|---|
hasNextPageBoolean! | Whether more items exist after this page. |
hasPreviousPageBoolean! | Whether more items exist before this page. |
startCursorString | Cursor of the first item of the page, to be used as |
endCursorString | Cursor of the last item of the page, to be used as |
totalInt! | Total number of items matching the query, ignoring pagination. |
PagesResponse
Result of a page mutation: the page on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
pagePage | The page as persisted after the mutation. Null when |
Payment
A single movement of money against a donation: the collection of a one-off gift or of one instalment of a recurring pledge, including its refunds.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the payment inside the organization. |
statePaymentState! | State of the payment. Only settled payments count towards the amount raised. |
amountFloat! | Gross amount of the payment, in the currency of the organization. |
paymentDateDateTime | When the money was collected. Null while the payment has not been settled. |
stripeIntentIdString | Deprecated: Deprecated on 2026-08-20, replaced by `processorTransaction { transactionId transactionIdType }`. The field only covers Stripe: it dates back to when Stripe was the only gateway, and it has no equivalent for PayPal, Satispay and SumUp. Not removed before 2027-08-20 because it is part of the public schema and is read by third-party apps. Identifier of the Stripe payment intent that collected the money. Deprecated: use |
createDateDateTime! | When the payment record was created. |
updateDateDateTime! | When the payment record was last modified. |
supporterSupporter | Supporter the money came from. Null when the payment is no longer linked to a donation. |
donationDonation | Donation the payment was collected for. Null when the donation was deleted. |
paymentMethodPaymentMethod | Method the money was collected with. Null when no method was recorded, for example on imported payments. |
processorTransactionProcessorTransaction | Reference of the transaction on the gateway, to reconcile this payment with the records of Stripe, PayPal, Satispay or SumUp. Null for payments with no external reference. |
netAmountFloat | Amount left after the fees charged by the gateway. Null when the fees are unknown or not reported by the processor. |
importRunImportRun | The import run that created this payment, when it came from a file import. Null for payments collected by Riseact. |
PaymentConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[PaymentEdge!]! | Items of this page, in the order defined by the query. |
PaymentEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodePayment! | The item itself. |
PaymentMethod
A way of paying offered to donors: either a gateway enabled for the organization or a manual method configured by hand, such as a bank transfer.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the payment method inside the organization. |
processorPaymentProcessor! | Gateway backing the method. |
hasOneoffSupportBoolean! | Whether the method can collect one-off donations. |
hasSubscriptionSupportBoolean! | Whether the method can collect recurring donations. |
labelString | Name shown to the donor on the payment step. |
descriptionString | Short explanation shown to the donor under the label. Set only on manual methods. |
instructionsString | Instructions the donor must follow to pay, such as the bank details for a transfer. Set only on manual methods. |
channels[Int!]! | Identifiers of the applications (channels) the method is offered on. Empty means every channel. |
includeInCertificateBoolean! | Whether payments collected with this method are counted in the yearly tax certificate of the supporter. |
sendInstructionsBoolean! | Whether the instructions are emailed to the donor after the donation. |
PaymentMethodResponse
Result of a payment method mutation: the method on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
paymentMethodPaymentMethod | The payment method as persisted after the mutation. Null when |
PaymentResponse
Result of a payment mutation: the payment on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
paymentPayment | The payment as persisted after the mutation. Null when |
PeerCampaign
A peer-to-peer fundraising page: a supporter collects donations for a campaign of the organization on their own page, with their own story and goal.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the document inside the organization. |
titleString! | Title of the page, used as its heading and in listings. |
contentString | Body of the page, as HTML. |
visibilityWebDocumentVisibility! | Whether the page is public, reachable only by direct link, or hidden. |
slugString! | URL segment identifying the page inside the site. Unique per organization. |
urlString! | Absolute URL of the page on the public site. |
seoTitleString | Title used in the |
templateString | Name of the theme template rendering the page. Empty to use the default one for this kind of document. |
seoDescriptionString | Meta description used by search engines and link previews. |
createDateDateTime! | When the document was created. |
updateDateDateTime! | When the document was last modified. |
supporterNameString | Name of the fundraiser as shown on the page. Falls back to the name of the supporter when empty. |
customMessageString | Personal appeal written by the fundraiser, shown on the page. |
goalFloat | Amount the fundraiser aims to raise. Meaningful only when |
isGoalEnabledBoolean! | Whether the goal and its progress bar are shown on the page. |
thankyouTemplateString | Name of the theme template rendering the thank-you page. Empty to use the one of the parent campaign. |
receiptNotificationIdInt | Notification used to send the receipt for donations collected on this page. Null to use the one of the parent campaign. |
sitefrontUrlString! | Absolute URL of the peer page on the public site. |
supporterSupporter | Supporter who is fundraising. Null when the page is no longer linked to one. |
campaignCampaign | Campaign the page collects for. Null when the parent campaign was deleted. |
PeerCampaignConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[PeerCampaignEdge!]! | Items of this page, in the order defined by the query. |
PeerCampaignEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodePeerCampaign! | The item itself. |
PeerCampaignResponse
Result of a peer campaign mutation: the page on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
peerCampaignPeerCampaign | The peer page as persisted after the mutation. Null when |
PrivacyDefinition
A consent the organization asks donors for, with the text shown next to it and the marketing permissions it grants.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the definition. |
codeString! | Stable code the consent is recorded under on supporters. |
labelString! | Short label shown next to the checkbox. |
messageString | Full text of the consent, shown to the donor. |
isDefaultBoolean! | Whether the consent is asked on every donation form unless the campaign says otherwise. |
isRequiredBoolean! | Whether the donor must give the consent to be able to donate. |
consentScopes[String!]! | Marketing permissions the consent grants, such as |
createDateDateTime! | When the definition was created. |
updateDateDateTime! | When the definition was last modified. |
PrivacyDefinitionConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[PrivacyDefinitionEdge!]! | Items of this page, in the order defined by the query. |
PrivacyDefinitionEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodePrivacyDefinition! | The item itself. |
PrivacyDefinitionResponse
Result of a consent mutation: the definition on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
privacyDefinitionPrivacyDefinition | The definition as persisted after the mutation. Null when |
ProcessorTransaction
Identifier of a payment on the gateway that processed it, used to reconcile a Riseact payment with the transaction recorded by Stripe, PayPal, Satispay or SumUp.
Fields
| Name | Description |
|---|---|
processorPaymentProcessor! | Gateway that processed the payment and therefore decides how to read |
transactionIdString | Identifier of the transaction on the payment gateway. Polymorphic: what it holds depends on the processor and is declared by |
transactionIdTypeProcessorTransactionIdType | What |
Project
A page that gathers several campaigns under one theme, either listed by hand or matched by rules.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the project inside the organization. |
titleString! | Title of the page, used as its heading and in listings. |
contentString | Body of the page, as HTML. |
visibilityWebDocumentVisibility! | Whether the page is public, reachable only by direct link, or hidden. |
slugString! | URL segment identifying the page inside the site. Unique per organization. |
urlString! | Absolute URL of the page on the public site. |
seoTitleString | Title used in the |
templateString | Name of the theme template rendering the page. Empty to use the default one for this kind of document. |
seoDescriptionString | Meta description used by search engines and link previews. |
createDateDateTime! | When the document was created. |
updateDateDateTime! | When the document was last modified. |
typeProjectType! | How the campaigns are chosen: listed by hand or matched by rules. |
rulesMatchProjectRuleMatchType! | Whether a campaign must satisfy every rule or just one of them. |
campaignsOrderProjectCampaignsOrder! | Order the campaigns are listed in. |
coverMedia | Cover image of the project page. Null when none was set. |
sitefrontUrlString! | Absolute URL of the project page on the public site. |
rules[ProjectRule!]! | Conditions campaigns must satisfy to be part of the project. Empty on projects listed by hand. |
items[ProjectCampaignItem!]! | Campaigns of the project, in the order they are listed. |
ProjectCampaignItem
A campaign listed in a project, together with its position in the list.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the entry. |
positionInt! | Position of the campaign in the list, ascending. |
campaignCampaign! | The campaign itself. |
ProjectConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[ProjectEdge!]! | Items of this page, in the order defined by the query. |
ProjectEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeProject! | The item itself. |
ProjectResponse
Result of a project mutation: the project on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
projectProject | The project as persisted after the mutation. Null when |
ProjectRule
One condition a campaign must satisfy to be part of a project.
Fields
| Name | Description |
|---|---|
uuidString! | Stable identifier of the rule inside the project. |
fieldProjectRuleField! | Field of the campaign the rule looks at. |
operatorProjectRuleOperator! | How the field is compared with the value. |
valueString! | Value the field is compared with, always as a string. |
Redirect
A redirect of the public site, used to keep old addresses working after a page is moved or renamed.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the redirect. |
sourcePathString! | Path on the site that is redirected, leading slash included. |
destinationUrlString! | Address visitors are sent to. |
RedirectConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[RedirectEdge!]! | Items of this page, in the order defined by the query. |
RedirectEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeRedirect! | The item itself. |
RedirectResponse
Result of a redirect mutation: the redirect on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
redirectRedirect | The redirect as persisted after the mutation. Null when |
SatispayPaymentResponse
A payment opened on Satispay, as returned by their API. The donor pays it in the Satispay app and Riseact settles the donation on the webhook.
Fields
| Name | Description |
|---|---|
idString | Identifier of the payment on Satispay. |
codeIdentifierString | Code the payment is addressed by, the one behind the QR code shown to the donor. |
typeString | Kind of payment opened on Satispay. |
amountUnitInt | Amount to pay, in cents. |
currencyString | Currency of the amount, as an ISO 4217 code. |
statusString | State of the payment as reported by Satispay. |
expiredBoolean | Whether the payment request has expired without being paid. |
insertDateString | When the payment was opened, as an ISO 8601 string. |
expireDateString | When the payment request expires, as an ISO 8601 string. |
descriptionString | Text shown to the donor in the Satispay app. |
flowString | Satispay flow the payment was opened with. |
externalCodeString | Reference Riseact attached to the payment, used to match it back to the checkout. |
redirectUrlString | URL to send the donor to in order to pay. |
Segment
A saved search: a set of filters over supporters or donations, kept under a name so it can be run again.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the segment. |
createDateDateTime! | When the segment was created. |
updateDateDateTime! | When the segment was last modified. |
nameString! | Name of the segment, shown in the back-office. |
entitySegmentEntity! | Kind of record the segment searches over. |
filtersJSON! | Filters of the segment, in the same shape as the ones taken by the search of that record. |
SegmentConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[SegmentEdge!]! | Items of this page, in the order defined by the query. |
SegmentEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeSegment! | The item itself. |
SegmentResponse
Result of a segment mutation: the segment on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
segmentSegment | The segment as persisted after the mutation. Null when |
Staff
The membership of a person in an organization: their role, their permissions and their preferences. The account itself lives on Riseact Accounts and is shared across organizations.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the membership. |
userIdInt | Identifier of the account on Riseact Accounts. Null for memberships not yet linked to an account. |
partnerIdInt | Identifier of the agency the member belongs to, when they are staff of a partner rather than of the organization. |
nameString | Display name of the member. |
emailString! | Email address the member signs in with. |
stateStaffStatus! | State of the membership. Only active members can sign in. |
langString! | Language the back-office and the notifications of the member are in. |
timezoneString! | Timezone dates are shown to the member in. |
createDateString | When the membership was created, as an ISO 8601 string. |
roleStaffRole! | Role of the member in the organization. |
bioString | Short description of the member, shown in the back-office. |
lastLoginDateString | When the member last signed in, as an ISO 8601 string. Null when they never did. |
isOwnerBoolean! | Whether the member owns the organization. The owner cannot be removed and always keeps every permission. |
permissions[StaffPermission!]! | Permissions actually granted to the member. |
StrConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[StrEdge!]! | Items of this page, in the order defined by the query. |
StrEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeString! | The item itself. |
StripeAccount
The Stripe account connected to the organization and what it is allowed to do.
Fields
| Name | Description |
|---|---|
accountIdString | Identifier of the connected account on Stripe. Null when none is connected. |
hasOneoffSupportBoolean! | Whether the account can collect one-off donations. |
hasSubscriptionSupportBoolean! | Whether the account can collect recurring donations. |
detailsSubmittedBoolean | Whether the organization completed the Stripe onboarding. |
chargesEnabledBoolean | Whether Stripe currently lets the account take payments. |
pubKeyString! | Publishable key to use in the browser with the Stripe client library. |
hasSepaEnabledBoolean! | Whether the account can collect SEPA direct debits on top of cards. |
StripeCard
A card the supporter saved on Stripe and that can be charged again.
Fields
| Name | Description |
|---|---|
idString! | Identifier of the payment method on Stripe. |
brandStripeCardBrand! | Card network. |
countryString! | Country the card was issued in, as a two-letter code. |
expMonthInt! | Expiry month of the card. |
expYearInt! | Expiry year of the card. |
fingerprintString! | Stripe fingerprint of the card, the same across saved copies of the same card. |
fundingStripeCardFunding! | Whether the card is credit, debit or prepaid. |
last4String! | Last four digits of the card. |
StripeCheckoutIntent
The Stripe payment intent opened for a checkout session, to be confirmed by the client.
Fields
| Name | Description |
|---|---|
clientSecretString! | Secret the Stripe client library confirms the payment with. Never log it and never share it beyond the paying browser. |
StripeCheckoutResponse
Result of opening a Stripe payment: the intent on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
checkoutStripeCheckoutIntent | The payment intent to confirm. Null when |
StripeLink
A short-lived link to a Stripe hosted page.
Fields
| Name | Description |
|---|---|
urlString! | URL to send the user to. It expires quickly and can be used once. |
StripeTerminal
A card reader paired with the Stripe account of the organization, used to collect donations in person.
Fields
| Name | Description |
|---|---|
idString! | Identifier of the reader on Stripe. |
labelString! | Name of the reader, shown in the back-office. |
serialNumberString! | Serial number printed on the device. |
statusString! | Whether the reader is currently reachable, as reported by Stripe. |
locationIdString | Identifier of the location the reader is installed at. |
locationStripeTerminalLocation | The location the reader is installed at. Null when it is not assigned to one. |
StripeTerminalLocation
A place card readers are installed at, as recorded on Stripe.
Fields
| Name | Description |
|---|---|
idString! | Identifier of the location on Stripe. |
displayNameString! | Name of the location, shown in the back-office. |
addressCityString! | City of the location. |
addressCountryString! | Country of the location, as a two-letter code. |
addressLine1String! | Street address of the location. |
addressLine2String | Second address line of the location. |
addressPostalCodeString! | Postal code of the location. |
addressStateString! | State or province of the location. |
terminalCountInt! | How many card readers are installed at the location. |
SumUpAccount
The SumUp account the organization collects card payments with on its own devices.
Fields
| Name | Description |
|---|---|
merchantCodeString | Code of the merchant on SumUp. Null when no account is connected. |
hasPaymentsBoolean! | Whether donations were already collected through this account. |
Supporter
A donor or contact of the organization: personal data, contact details, marketing consents and giving history. Supporters are unique per organization.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the supporter inside the organization. |
archivedBoolean | Whether the supporter is archived. Archived supporters are hidden from the default lists but are never deleted. |
codeString! | Human-readable identifier of the supporter, shown in the back-office. |
createDateDateTime! | When the supporter record was created. |
imageString | URL of the profile picture of the supporter. Null when none was uploaded. |
businessNameString | Legal name of the company, family or group. Null for private persons. |
firstNameString | Given name. Null for supporters that are not private persons. |
lastNameString | Family name. Null for supporters that are not private persons. |
fullNameString | Display name of the supporter, computed from the personal or business name. Read-only. |
supporterTypeSupporterType | Nature of the supporter, which decides whether the personal or the business fields apply. |
emailString | Main email address, used for receipts and notifications. |
phoneString | Landline number. |
mobileString | Mobile number, used for SMS notifications. |
sexSex | Gender recorded on the supporter. |
dateOfBirthDate | Date of birth, required by some tax receipt regimes. |
placeOfBirthString | Place of birth, required by some tax receipt regimes. |
ssnString | National tax identifier of the person (in Italy, the codice fiscale). Needed to issue a deductible receipt. |
vatString | VAT number of the company. Applies to business supporters. |
titleString | Courtesy title, such as Dr. or Prof. |
jobString | Job or role declared by the supporter. |
addressString | Street address. |
address2String | Second address line, for care-of details or the like. |
cityString | City of the address. |
localityString | Locality or province of the address. |
countryString | Country of the address. |
postalCodeString | Postal code of the address. |
certificationUrlString | URL of the signed acquisition document collected for the supporter, such as the consent form or the direct debit mandate. Exposed to notification templates as |
privacyBoolean | Whether the supporter accepted the privacy policy. The per-purpose consents are in |
emailMarketingBoolean | Consent to receive marketing messages by email. |
phoneMarketingBoolean | Consent to be contacted for marketing by phone. |
smsMarketingBoolean | Consent to receive marketing messages by SMS. |
postalMarketingBoolean | Consent to receive marketing material by post. |
profilationMarketingBoolean | Consent to have their data profiled for marketing purposes. |
tags[String!]! | Free-form labels attached to the supporter, used for filtering and segmentation. |
noteString | Free-text note attached by the operator. Internal, never shown to the supporter. |
stripeCustomerIdString | Identifier of the matching customer on Stripe, used to charge the cards saved by the supporter. Null when the supporter never paid by card. |
externalRefString | Identifier of the supporter in the external system they were imported from, unique per organization and used to deduplicate rows on re-import. |
importRunImportRun | The import run that created this supporter, when they came from a file import. Null for supporters created in Riseact. |
customfields[CustomField!]! | Values of the custom fields defined by the organization for supporters. |
privacyValues[SupporterPrivacyValue!]! | Consents given by the supporter, one entry per privacy definition of the organization. |
sourceCampaignCampaign | Campaign the supporter was acquired through. Null when the origin is unknown. |
sourcePeerCampaignPeerCampaign | Peer-to-peer page the supporter was acquired through. Null when they did not come from one. |
totalDonationsInt! | Number of donation pledges made by the supporter. |
totalDonatedString! | Total amount actually collected from the supporter, as a decimal string. |
averageDonationString! | Average amount collected per donation, as a decimal string. |
lastOneoffDonationDonation | Most recent one-off donation of the supporter. Null when they never gave a one-off gift. |
activeRegularDonations[Donation!]! | Recurring pledges of the supporter that are still being collected. |
savedCards[StripeCard!]! | Cards the supporter saved on Stripe and that can be charged again. |
SupporterConnection
A page of results, in the Relay connection shape: the items are under edges, the state of the pagination under pageInfo.
Fields
| Name | Description |
|---|---|
pageInfoPageInfo! | State of the pagination for this page. |
edges[SupporterEdge!]! | Items of this page, in the order defined by the query. |
SupporterEdge
One item of a paginated list, together with the cursor that points at it.
Fields
| Name | Description |
|---|---|
cursorString! | Opaque cursor of this item, to be passed as |
nodeSupporter! | The item itself. |
SupporterPrivacyValue
A consent recorded on a supporter, resolved against the privacy definitions of the organization.
Fields
| Name | Description |
|---|---|
codeString! | Code of the privacy definition the consent refers to. |
labelString! | Human-readable label of the privacy definition. |
valueBoolean! | Whether the consent was given. |
dateDateTime | When the consent was collected. Null for consents recorded without a date. |
SupporterResponse
Result of a supporter mutation: the supporter on success, or the validation errors that prevented it.
Fields
| Name | Description |
|---|---|
userErrors[UserError!] | Validation errors that prevented the operation. Null or empty when the mutation succeeded. |
supporterSupporter | The supporter as persisted after the mutation. Null when |
User
A person with an account on Riseact Accounts, identified by their email address.
Fields
| Name | Description |
|---|---|
idInt! | Unique identifier of the user. |
emailString! | Email address the user signs in with. |
nameString | Display name of the user. |
verificationTokenString | Token to verify the email address of the user. Null once the address is verified. |
UserError
A single validation error that prevented a mutation from completing. Reported to the caller instead of raising, so the client can show it next to the offending field.
Fields
| Name | Description |
|---|---|
codeErrorCode! | Machine-readable classification of the error. |
fieldString | Name of the input field the error refers to, when it can be attributed to one. Null for errors about the operation as a whole. |
messageString | Human-readable message, already translated into the language of the request. |