For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact usLogin
GuidesAPI ReferenceFDX APIChangelog
GuidesAPI ReferenceFDX APIChangelog
  • Introduction
    • Overview
    • Authentication
    • Errors
    • Software Development Kits
    • Webhooks and Events
    • Sandbox Simulations
  • Core Resources
      • GETList Event Subscriptions
      • POSTCreate an Event Subscription
      • GETGet an Event Subscription
      • PATCHUpdate an Event Subscription
  • DAFpay
  • Donor Accounts
  • Disbursements
  • Gift Processing
LogoLogo
Contact usLogin
Core ResourcesEvent Subscriptions

Update an Event Subscription

PATCH
/v1/event_subscriptions/:id
PATCH
/v1/event_subscriptions/:id
$curl -X PATCH https://api.givechariot.com/v1/event_subscriptions/id \
>     -H "Authorization: Bearer <token>" \
>     -H "Content-Type: application/json" \
>     -d '{}'
1{
2  "url": "https://example.com/webhook",
3  "id": "4d06d393-1f14-46cf-b02d-8db17d7ed06a",
4  "created_at": "2024-01-14T12:48:56.37Z",
5  "status": "active",
6  "category": "grant.created"
7}
Update an event subscription with the given ID.
Was this page helpful?
Previous

Create Connect

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The unique identifier for the event subscription

Request

The request body for creating an event subscription
statusenumOptional
The status of the event subscription: * active: The event subscription is active and events will be delivered * disabled: The event subscription is temporarily disabled and events will not be delivered * deleted: The event subscription is permanently deleted and events will not be delivered
Allowed values:

Response

Updated
urlstring
The webhook url where we'll send notifications.
idstringRead-only
The unique identifier for the event subscription
created_atstringRead-onlyformat: "date-time"
The date and time the event subscription was created
statusenum

The status of the event subscription. This indicates if we’ll send notifications to this subscription

  • active: subscription is active and events will be delivered normally
  • disabled: subscription is temporarily disabled and events will not be delivered
  • deleted: subscription has been deleted and events will not be delivered
  • requires_attention: subscription has been disabled due to delivery failures and events will not be delivered
Allowed values:
categoryenum

The category of the event. This is useful for filtering events.

Event names follow the pattern {resource}.{event_type} where event_type is either created or updated. Status transitions (for example, a Donor Account moving to approved or rejected) are emitted as {resource}.updated events — fetch the object to read its current status.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error

The status of the event subscription:

  • active: The event subscription is active and events will be delivered
  • disabled: The event subscription is temporarily disabled and events will not be delivered
  • deleted: The event subscription is permanently deleted and events will not be delivered