docs: updates for changes to donation details, fundraiser state, and webhooks

Author: prognostikos

schema/schemata/donation-detail.yml

@@ -129,6 +129,13 @@ definitions:
     example: Christmas Donation
     type:
       - string
+  form_type:
+    example: online_form
+    type:
+      - string
+    enum:
+      - online_form
+      - door_to_door_form
   custom_form_values:
     "$ref": "/schemata/common#/definitions/custom_form_values"
   payment:
@@ -257,6 +264,8 @@ properties:
     "$ref":  "/schemata/project#/definitions/erp_product_number"
   donor_reference:
     "$ref": "/schemata/donation-detail#/definitions/donor_reference"
+  form_type:
+    "$ref": "/schemata/donation-detail#/definitions/form_type"
 type:
 - object
 id: schemata/donation-detail

schema/schemata/fundraiser.yml

@@ -53,8 +53,17 @@ definitions:
     description: The monetary goal for this fundraiser
     "$ref": "/schemata/common#/definitions/amount"
   state:
-    description: The state of this fundraiser
-    "$ref": "/schemata/common#/definitions/state"
+    description: The state of this fundraiser. Fundraisers in the draft and trashed states are not available via the API.
+    example: published
+    type:
+      - string
+    enum:
+      - draft
+      - finished
+      - finished_hidden
+      - hidden
+      - published
+      - trashed
   headline:
     description: The headline for this fundraising page
     example: "Firstname Lastname's Fundraiser for HelpNow"

source/includes/resources.md

@@ -243,7 +243,7 @@ HTTP/1.1 200 OK
 ## <a name="resource-donation-detail">Donation Details</a>
 
 
-The private details about a donation. Includes Personally Identifieable Information. A secret key is required to access this information.
+The private details about a donation. Includes Personal data. A secret key is required to access this information.
 
 ### Attributes
 
@@ -299,6 +299,7 @@ The private details about a donation. Includes Personally Identifieable Informat
 | **[event:name](#resource-common)** | *string* | the name of the Event | `"Copenhagen Marathon 2013"` |
 | **[event:url](#resource-common)** | *uri* |  | `"https://api.betternow.org/events/1234567"` |
 | **first_name** | *string* | The first name on the donation | `"Firstname"` |
+| **form_type** | *string* | <br/> **one of:**`"online_form"` or `"door_to_door_form"` | `"online_form"` |
 | **[fundraiser:html_url](#resource-common)** | *uri* | The current url to view the organisation page on BetterNow. This can, and does, change. Requests to old urls will be redirect to the current url. | `"https://dk.betternow.org/charities/helpnow"` |
 | **[fundraiser:id](#resource-common)** | *string* | Unique identifier of organisation | `1234567` |
 | **[fundraiser:name](#resource-common)** | *string* | The name of the Organisation | `"HelpNow"` |
@@ -468,7 +469,8 @@ HTTP/1.1 200 OK
     "utm_campaign": "example"
   },
   "erp_product_number": "4000",
-  "donor_reference": "Christmas Donation"
+  "donor_reference": "Christmas Donation",
+  "form_type": "online_form"
 }
 ```
 
@@ -994,7 +996,7 @@ Detailed information about a single Fundraising Page on BetterNow.org
 | **[recipient:name](#resource-common)** | *string* | The name of the Organisation | `"HelpNow"` |
 | **[recipient:url](#resource-common)** | *uri* |  | `"https://api.betternow.org/organisations/1234567"` |
 | **[slug](#resource-common)** | *string* | The current url path component to identify the fundraiser. This can, and does, change.<br/> **pattern:** `^([a-z0-9-]{2,})$` | `"firstname-lastnames-fundraiser-for-helpnow"` |
-| **[state](#resource-common)** | *string* | The state of this fundraiser | `"published"` |
+| **state** | *string* | The state of this fundraiser. Fundraisers in the draft and trashed states are not available via the API.<br/> **one of:**`"draft"` or `"finished"` or `"finished_hidden"` or `"hidden"` or `"published"` or `"trashed"` | `"published"` |
 | **[team:html_url](#resource-common)** | *uri* | The url to the Team page on BetterNow | `"https://dk.betternow.org/teams/team-novo"` |
 | **[team:id](#resource-common)** | *string* | unique identifier of team | `1234567` |
 | **[team:name](#resource-common)** | *string* | the name of the Team | `"Team NOVO"` |

source/includes/webhooks.md

@@ -45,6 +45,7 @@ between first publication date and end-date |
 | fundraiser_fifty_percent_goal_reached | The fundraiser has reached 50% of its goal |
 | fundraiser_one_hundred_percent_goal_reached | The fundraiser has reached 100% of its goal |
 | fundraiser_company_profile_updated | The company profile attached to the fundraiser has been updated |
+| fundraiser_trashed | The fundraiser has been deleted/trashed |
 
 <aside class="warning">
 The <code>end_date</code> and <code>goal</code> can be
@@ -61,6 +62,7 @@ times if the end date is changed.
 | team_created_by_system | A team page is created via an integration with a third-party system |
 | team_created_by_user | A team page is created on the web site |
 | team_edited | A team page is edited |
+| team_trashed | The team page has been deleted/trashed |
 
 ### Donation activities
 | Activity Type | Description |

source/index.html.md

@@ -41,6 +41,12 @@ any questions.
 
 ## Changelog
 
+2026-01-21:
+
+- added `form_type` to /donation-details
+- added `fundraiser_trashed` and `team_trashed` webhook notifications
+- added missing documenation of the possible values for fundraiser `state`
+
 2025-10-23:
 
 - updated webhook notification retry policy: the system will now retry delivery

source/schema.json

@@ -554,6 +554,16 @@
             "string"
           ]
         },
+        "form_type": {
+          "example": "online_form",
+          "type": [
+            "string"
+          ],
+          "enum": [
+            "online_form",
+            "door_to_door_form"
+          ]
+        },
         "custom_form_values": {
           "$ref": "#/definitions/common/definitions/custom_form_values"
         },
@@ -640,7 +650,7 @@
           }
         }
       },
-      "description": "The private details about a donation. Includes Personally Identifieable Information. A secret key is required to access this information.",
+      "description": "The private details about a donation. Includes Personal data. A secret key is required to access this information.",
       "links": [
         {
           "description": "Info for existing donation.",
@@ -746,6 +756,9 @@
         },
         "donor_reference": {
           "$ref": "#/definitions/donation-detail/definitions/donor_reference"
+        },
+        "form_type": {
+          "$ref": "#/definitions/donation-detail/definitions/form_type"
         }
       },
       "type": [
@@ -1311,8 +1324,19 @@
           "$ref": "#/definitions/common/definitions/amount"
         },
         "state": {
-          "description": "The state of this fundraiser",
-          "$ref": "#/definitions/common/definitions/state"
+          "description": "The state of this fundraiser. Fundraisers in the draft and trashed states are not available via the API.",
+          "example": "published",
+          "type": [
+            "string"
+          ],
+          "enum": [
+            "draft",
+            "finished",
+            "finished_hidden",
+            "hidden",
+            "published",
+            "trashed"
+          ]
         },
         "headline": {
           "description": "The headline for this fundraising page",