JSON POST Webhook and Push-to-API¶

The JSON POST Webhook and Push-to-API features in Evergiving enable seamless integration with external systems by sending real-time data in JSON format. This is particularly useful for automating workflows and pushing data to external platforms like CRMs or fundraising tools such as Raisely.

What is a Webhook?¶

A webhook is a method for sending real-time data to another system when an event occurs in Evergiving (e.g., a donation or a pledge is made). This allows external systems to receive up-to-date information without needing manual exports.

Push-to-API: How Does It Work?¶

Push-to-API enables Evergiving to send data directly to an external system’s API using the JSON POST method. It’s ideal for connecting Evergiving to platforms like CRMs or fundraising systems such as Raisely.

Target API: The destination where Evergiving sends the data (e.g., a CRM system or fundraising platform).
API Key: A unique identifier that authenticates Evergiving with the target system’s API to ensure secure data transmission.

Options for Raisely¶

Raisely is an online fundraising platform that integrates with Evergiving via its API. When exporting data to Raisely, the API key provided in Raisely’s campaign settings is required for authentication. You can find this API key under API & Webhooks in the Raisely settings page.

Data Format: JSON¶

Evergiving sends data through webhooks and APIs in JSON format. JSON is a widely-used data format that structures data in key-value pairs.

Example of a simple JSON document:

{
  "name": {
    "first": "John",
    "last": "Doe"
  }
}

The structure of the JSON document is determined by the schema columns configured in Evergiving. You can use either Simple Format or JSON Path Format to structure the data.

Simple vs. JSON Path Formats¶

Simple Format: Uses double underscores (__) to represent nested structures in JSON. It is ideal for straightforward data needs.
JSON Path Format: A more advanced format for handling complex data structures, such as arrays or properties with special characters. This format uses $ to represent the root object and supports deep nesting.

Key Use Cases¶

Real-Time Data Transfer: Automatically send data to external systems as soon as it’s available in Evergiving.
API Integration: Push data to platforms such as Raisely or custom-built APIs.
Automation: Streamline data transfers without the need for manual intervention.

When to Use¶

When you need to automate the transfer of donor or pledge data to a CRM or external platform.
When external systems require real-time data updates for reporting or analytics.
When integrating Evergiving with third-party fundraising systems like Raisely or custom API endpoints.