Schema
The root-level fields define the structure of every donation notification. They identify the schema type, source platform, and contain all entity data for the notification.
| Field | Type | Description |
|---|---|---|
schema |
String | Always set to "donation". |
schemaVersion |
Object | Identifies the version of the donation schema using major, minor, and build structure. |
platform |
String | The platform responsible for creating the notification (e.g., "facebook"). |
platformLabel |
String | The display label for the platform (e.g., "Facebook"). |
platformVersion |
Object | Identifies the version of the platform integration using major, minor, and build structure. |
prefix |
String | Prefix appended to every key, used to prevent overlapping keys when there are multiple instances of the same platform integrated with MoveData (e.g., "usa"). |
client |
String | Used when a platform inherits a specific client as part of its implementation (e.g., "csv"). |
action |
String | Denotes what the notification is for. Values: "metadata" (campaigns, recurring changes, fundraisers, etc.) or "donation" (donation information). |
campaign |
Array of Campaign | An array of Campaign objects. Each campaign represents a fundraising effort associated with a donation or registration. |
anonymous |
Boolean | Identifies if the donation is anonymous. |
donor |
Person or Organisation | Primary contact person or organisation responsible for the donation. |
tribute |
Tribute | Identifies a donation made in memory or honour of someone. |
matched |
Matched | Contains information about a matching donation. |
recurring |
Recurring | Identifies start date, amount, and frequency for a recurring donation. |
donation |
Donation | Contains dates, descriptions, and financially related information for the donation. |
newsletter |
Boolean | Identifies if the subject of the notification has opted into or out of communications. Superseded by communication entries on party entries. |
custom |
Object | Key/value object with values that do not fit within the schema. |
questions |
Array of Question | Custom questions and answers associated with the notification. |
global |
Object | Key/value object with values that need to be globally available throughout a notification. |
createdAt |
DateTime | The creation date/time of the notification or data contained within. |
modifiedAt |
DateTime | The last updated date/time of the notification or data contained within. |