Raisely charges a small fee per API call. Refer to Raisely's pricing documentation for current API costs.
The Raisely integration allows Vega to automatically create or update contacts and import donations from your Raisely campaigns.
Two integration methods are available:
- Raisely Webhooks – automatically sends new donations and profile updates to Vega in real time.
- Raisely API Import – manually imports donations from Raisely for a selected date range.
Both methods are configured from:
Admin → External Webhooks and APIs
Choosing an Integration Method
| Method | Best For |
|---|---|
| Webhooks | Automatically importing donations and fundraiser updates as they occur. |
| API Import | Importing historical donations or manually retrieving transactions for a specific date range. |
Setting Up Raisely Webhooks
Step 1 – Create a Webhook in Vega
Navigate to:
Admin → External Webhooks and APIs → Raisely Webhooks
Raisely Webhooks
Click Add Web Hook.
Complete the following fields:
| Field | Description |
|---|---|
| Webhook Name | A descriptive name for the connection (usually the campaign name). |
| Centres (Optional) | Select a Centre or Donation Centre if applicable. |
| Campaign | The Vega campaign that imported donations will be associated with. An External List campaign is commonly used. |
| Raisely Campaign Code | Enter the Campaign UUID from Raisely. |
| Secret Key (Optional) | Generate a shared secret key for additional security. Although optional in Raisely, this is recommended, particularly when sharing campaigns across multiple organisations or branches. |
Click Add to save the webhook.
Once created, map the required GL Codes.
Step 2 – Configure the Webhook in Raisely
In Raisely:
- Open the required campaign.
- Go to Settings → API & Webhooks → Webhooks.
- Click Add Webhook.
- Subscribe to the following events:
- Donation Succeeded
- Profile Created (Peer-to-Peer campaigns only)
- Profile Updated (Peer-to-Peer campaigns only)
Note
A separate webhook must be configured for each Raisely campaign you wish to connect to Vega.
Setting Up a Raisely API Import
Note
A separate API connection is required for each Raisely campaign.
Step 1 – Obtain Your Raisely API Key
In Raisely:
- Open the required campaign.
- Navigate to Settings → API & Webhooks → API Keys.
- Copy the campaign API Key.
Step 2 – Create an API Connection in Vega
In Vega, navigate to:
Admin → External Webhooks and APIs → Raisely API Import
Click Add API Import.
Note
It is recommended to create separate imports for profiles and donations so that profiles can be imported and then the donations, this is especially important if you're using the filtering options.
| Field | Description |
|---|---|
| API Name | A descriptive name for the connection. |
| Raisely Campaign Code | Enter the Campaign UUID from Raisely. |
| Default Campaign | Select the Vega campaign to which imported donations should be assigned if they don't match any specific filters. |
| Default Pay Type | Select the pay type to which imported donations should be assigned. |
| API Key | Enter the API Key generated in Raisely. |
| Pricing | This checkbox must be selected to confirm you agree with Vega pricing when using the Raisely API import. |
| Is Active | Sets the import connection as active and available to use. |
| Ignore Offline | When this is checked, offline donations entered in Raisely will be ignored by the import. |
| Ignore Receipt Nos | When this is checked, Vega will treat these payments as unreceipted, and they will be included in annual receipts. |
| Default OK To Contact? | When this is checked, contacts will be set as OK to Contact with your organisation default reason. You can use Raisely attribute settings to set specific options based on Raisely attributes. |
| Import Donations | When this is checked, the donation object will be included in the import. |
| Import Profiles | When this is checked, the profile object will be included in the import. This includes profiles created and profiles updated. |
Click Add.
Map the required GL Codes.
Step 3 – Import Data
Navigate to:
Money → Webhooks and API Log
Click Import from API.
Select:
- the required API connection
- a From date
- a To date
Click Import.
Note
Large imports may take several minutes to complete.
Viewing Imported Data
All imported webhook and API activity can be viewed from:
Money → Webhooks and API Log
Depending on the event received, the source will display as:
- Raisely Donation
- Raisely Contact Update
- Raisely Profile Update
Because these records originate from Raisely, they do not contain a Widget ID or Widget Name.
Contact Matching
When data is received from Raisely:
- Vega first attempts to match the contact using existing records.
- If no match is found, a new contact is created.
- An External ID is stored against the contact to ensure future updates are matched correctly.
Peer-to-Peer Fundraisers
For Peer-to-Peer campaigns, Vega stores additional fundraiser information under Peer-to-Peer Details on the Contact Dashboard, including:
- Campaign Name
- Campaign Description
- Raisely URL Path
- Fundraising Target
- Team Name
If the fundraiser belongs to a team:
- a Team contact is created automatically
- the fundraiser is linked using the Team Member relationship
Donations received through Peer-to-Peer campaigns are imported as Supporter-Led Payments, including:
- fundraiser
- team
- supporter message (stored in Pay Details)
|
Profile Field Mapping
Donation Field Mapping
|
Related article: Raisely Attribute Filtering and Mapping
“Some content in this article may have been developed with the assistance of AI tools and reviewed by staff.”
Comments
0 comments
Please sign in to leave a comment.