Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Chariot Event Subscriptions API

The Event Subscriptions API from Chariot — 2 operation(s) for event subscriptions.

Chariot Event Subscriptions API is one of 29 APIs that Chariot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 4 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 6.0.

Requests are made against 2 base URLs: https://api.givechariot.com/fdx/v6, https://devapi.givechariot.com/fdx/v6.

4 operations 2 paths 4 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
6.0
Base URL
https://api.givechariot.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Chariot Event Subscriptions API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 Bearer token. A client may hold both scopes, but each FDX authorization must contain exactly one — they are mutually exclusive per authorization. An…

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Event Subscriptions 4
POST
/v1/event_subscriptions
Create an Event Subscription
createEventSubscription body → 201400401403404500
GET
/v1/event_subscriptions
List Event Subscriptions
listEventSubscriptions 2 params → 200400401403500
GET
/v1/event_subscriptions/{id}
Get an Event Subscription
getEventSubscription 1 param → 200400401403404500
PATCH
/v1/event_subscriptions/{id}
Update an Event Subscription
updateEventSubscription 1 param body → 200400401403404500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are EventSubscription (5 properties), ProblemDetails (4 properties). Each schema is shown below with its type and property counts.

EventCategory
string
The category of the event. This is useful for filtering events. Event names follow the pattern {resource}.{eventtype} where eventtype is either created or upda…
ProblemDetails
object
RFC 7807 problem-details error (media type application/problem+json). The status field is an integer HTTP status code.
4 properties 4 required
EventSubscription
object
Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them.
5 properties 1 required
EventSubscriptionStatus
string
The status of the event subscription. This indicates if we'll send notifications to this subscription active: subscription is active and events will be deliver…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

chariot-event-subscriptions-api-openapi.yml Raw ↑

Other APIs Chariot publishes across the network.

Chariot Accounts API
Chariot Authorization Tokens API
Chariot Connects API
Chariot Contact API
Chariot Customers API
Chariot deposits API
Chariot disbursements API
Chariot donations API
Chariot Donor Accounts API
Chariot Donor Advised Funds API
Chariot Events API
Chariot financial_accounts API