Skip to content

Evergiving API Guide

The Evergiving API allows other websites or apps to connect directly with Evergiving. Allowing for more streamline and accurate data communication. Some useful functions are to:

  • Automatically get donation records into your accounting software
  • Sync donor information with your CRM (like Salesforce)
  • Build custom reports in tools like Power BI

Overall, it streamlines the integration between platforms and your digital assets, ensuring that all donation-related operations can be managed programmatically without manual intervention.

What is an API?

An API (Application Programming Interface) is a universal standard that communicates between different applications.

New to APIs? Watch This First

(4-minute overview of key concepts)

When an app or website needs to do something - say, fetch information:

  1. It sends a request to a specific URL (the API's address) using a method like GET or POST. This request includes required details such as parameters, data formatted in a specific way (like JSON), and often an authentication key to verify your identity.
  2. The server then receives the request, checks these requirements, processes the request by accessing a database or running specific logic, and finally
  3. Sends back a response with the data or a status message.

This entire process happens over the internet and abstracts away the complexities, allowing your app to interact smoothly with the server's services.

This is an example of what these URLs look like

Example URL

GET(1) https://api.evergiving.com/api/v4/pledges(2)/next_batch?(3)campaign_id(4)=513&schema_id(5)=1451&after_version(6)=5911924...

  1. HTTP Method - GET to request, POST to send
  2. API Endpoint - /leads, /pledges, /teams etc
  3. Endpoint Attribute
  4. Campaign ID - ID of the campaign.
  5. Schema ID - ID of the schema used for selecting data
  6. Conditional Parameter - This one receives pledges with a version higher than this.

Security Features

API keys function as your unique digital password, ensuring only authorized access to your data. All requests are securely transmitted over HTTPS, protecting sensitive information from interception. With granular permissions control, you decide exactly what external applications can access which campaign, allowing for precise data-sharing settings.

Data Retrieval & Updates

New donation records are retrieved automatically every 15 minutes, though you can customize the schedule to fit your needs. If you're only interested in recent changes, the "What's new?" mode ensures you receive only the updates since your last check.

Example Workflow for Creating an API Address

  1. Log in as an Admin user
  2. Go to Account > API Tokens
    1. Create new API token
    2. Give it a name and select the required campaign
    3. Backup and copy the displayed token

  3. Go to Export > Pledges

    1. Add Pledge Export Builder
    2. Give it a name and select the campaign from earlier
    3. Set Output Type as JSON API
    4. Add data Sources to the schema
    5. Apply any data transformations and filters
    6. Click Save

  4. Testing: Submit test pledges, create conditions for testing, and verify output.

  5. Implementation: Remove test conditions, add production conditions, and ensure data is accurate.

Read More

View the Full API Reference.