Connectors / Service / Donately

Online Donation forms and Fundraising pages. (updated: 1657717015925)

Donately

Donately is a platform for creating online donation forms and fundraising pages.

Overview

Donately is a platform that improves the donation experience through donation forms, fundraising pages and text messages to enable the collection of donations digitally. It enables integration with other web applications and improves donation revenue through its peer-to-peer fundraising pages, and recurring donations feature.

API Information

The Base URL used for the Donately connector is https://api.donately.com/v2. More information can be found on their main API documentation (v2019-03-15) site.

Authentication

Within the builder, click on the Donately connector to display the connector properties panel. Select the 'Auth' tab and click on the 'New authentication' button.

donately-authentication

In the Tray.io authentication pop-up modal, name the authentication in a way that will quickly identify it within a potentially large list. For example, whether it is a Sandbox or Production auth, etc.

Consider who/ how many people will need access to this authentication when choosing where to create this authentication ('Personal' or 'Organisational').

The second page asks you for your 'Account ID' and 'API Token' credentials.

donately-auth-creds

To get these fields, head to the Donately dashboard. Click on the API integrations page.

Here you can see your 'Account Id'.

donately-dash-account-id

Click on the 'Show API Token' button to get the API Token.

donately-dash-account-api-token

Once you have added these fields to your Tray.io authentication pop-up window, click the 'Create authentication' button. 

Your connector authentication setup should now be complete.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Using the Raw HTTP Request ('Universal Operation')

As of version 1.0, you can effectively create your own operations.

This is a powerful feature that you can use when there is an endpoint in Donately that is not used by any of our operations.

To use this, you will first of all need to research the endpoint in the Donately API documentation v2019-03-15 to find the exact format that Donately will be expecting the endpoint to be passed in.

For example, say that the List donations operation did not exist in our Donately connector, and you wanted to use this endpoint. You would use the , Donately API docs to find the relevant endpoint - which in this case is a `GET` request called: `/donations`.

More details about this endpoint can be found here.

donately-api-get

Based on the information provided in the above API call doc, you need to configure the following attributes on your Tray platform:

  • Method: GET

  • URL:  

    • Endpoint : /donations

  • Headers: None

  • Query parameters:

Donately-Version: 2020-11-03

account_id : <account Id>

  • Body Type: none

donately-raw-http

Once the API call is executed successfully, you should get the following results:

donately-raw-http-output

Example Usage

TRAY POTENTIAL: Tray.io is extremely flexible. By design there is no fixed way of working with it - you can pull whatever data you need from other services and work with it using our core and helper connectors.

Below is an example of a way in which you could potentially use the Donately connector, to update a list of campaigns.

The overall logic of the workflow is:

  1. Setup using a manual trigger.

  2. It gets a list of campaigns belonging to an account.

  3. Loops through the campaigns.

  4. Updates the campaign descriptions.

  5. Lists the updated campaigns.

Your completed workflow should look similar to this:

donately-wf

Step-by-step Explanation

BEST PRACTICES: Whenever you do decide to create your own workflow, please make sure you take a look at our managing data best practices guide.

All Operations

Latest version:

1.0

List campaigns

Retrieve a list of existing campaigns for an account.

List campaigns DDL

List donations

Retrieve a list of existing donations paid to an account.

List donations DDL

List fundraisers

Retrieve a list of fundraisers for the account.

List fundraisers DDL

List people

Retrieve a list of donors and contacts for an account.

List people DDL

List subscriptions

Retrieve a list of existing recurring donations for an account.

List subscriptions DDL

Raw HTTP request (advanced)

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Update campaign

Update a campaign.

Update donation

Update a donation.

Update fundraiser

Update a fundraiser.

Update person

Update a person's details.

Update subscription

Update an existing recurring donation for an account.