Read-only
None of the endpoints documented here accept writes. (The Salesforce family also has aPOST /salesforce/v1/events/{eventId}/clone endpoint used by the Givergy Salesforce app; it is not part of the public export surface.) Event creation, item creation, payment capture, refunds, and any other state-changing operations are performed through the Givergy product UI.
Coming Soon — write/mutation endpoints. Write capabilities (creating events, items, processing payments) are scoped per integration. Contact support@givergy.com to discuss your use case.
Connector payloads are leaner than Custom Data Export
The Salesforce and Blackbaud connector endpoints intentionally restrict the payload to the subset their respective CRMs natively ingest. If you need:- Payment status, processor type, or project segment fields, or
- Descriptive item fields (description, terms, categories, IRS subcategories, bid increments, starting prices, tax rates, estimates), or
- Guest
externalId,smsOptIn, orcompanyName
Multi-region: independent deployments
The four production hostnames listed in Base URL and regions are independent deployments with independent databases. Cross-region queries aren’t possible — an integration is always scoped to a single region. If you need data from multiple regions, run separate integrations per region.Coming Soon — additional regions. Contact support@givergy.com if your data-residency needs aren’t covered today.
Auth model: API keys only
The API authenticates with long-lived API keys. OAuth 2.0 is not supported. Plan for key rotation and secret storage — see Authentication for credential-handling guidance.Enum serialization: lowercase only
All enum values are lowercase in JSON. Code-generated clients that assume uppercase will not deserialize correctly. See Conventions.giftAidStatus values
Only not_asked, yes, no are valid wire values. Treat anything else as a future addition and surface it as opaque rather than crashing — Givergy may add new values over time without considering that a breaking change.
Earlier Givergy reference material listed values like CLAIMED, PENDING, NOT_REQUESTED. Those were incorrect.
Rate-limit thresholds aren’t publicly fixed
Concrete rate-limit thresholds are tuned periodically and vary by region. Plan for 1 request per second per integrator and contact support@givergy.com in advance if you expect to need higher quotas. See Rate limiting.No webhook notifications today
There are no push notifications for resource changes today. Use the polling pattern withsince.
Coming Soon — webhook notifications. Contact support@givergy.com to express interest.
New connector and destination shapes
Coming Soon — new CRM and warehouse connectors. HubSpot, Microsoft Dynamics, NetSuite, Raiser’s Edge, Snowflake, BigQuery, and any other destination with a stable ingestion interface. Each new family is built on the same foundation as the Custom Data Export and existing connector shapes. Contact support@givergy.com to scope.