Authorization Tokens5

Connects2

deposits2

disbursements10

donations2

Donor Accounts6

Donor Advised Funds2

Event Subscriptions4

Events2

files5

financial_accounts3

Giving Pools2

Grant Requests4

Grants5

inboundTransfers6

lockboxes2

mailbox2

mailItems2

nonprofitAddresses1

nonprofitContacts1

Organizations3

paymentSources2

Programs2

properties4

recurring_grants3

unintegrated_grants2

verificationRequests3

Event Subscriptions

Update an Event Subscription

Update an event subscription with the given ID.

patch/v1/event_subscriptions/{id}

Path parameters

idstring required

The unique identifier for the event subscription

Request body

status'active' | 'disabled' | 'deleted'

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

Response

Updated

idstring

The unique identifier for the event subscription

created_atstring date-time

The date and time the event subscription was created

status'active' | 'disabled' | 'deleted' | 'requires_attention'

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

urlstring required

The webhook url where we'll send notifications.

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.

Example response

{
  "id": "4d06d393-1f14-46cf-b02d-8db17d7ed06a",
  "created_at": "2024-01-14T12:48:56.37Z",
  "url": "https://example.com/webhook"
}

Changes

Changed in 7 of the 41 revisions of this API.251549

Jun 29, 2026b87f7738d3361025See the full diff
- ▲
  removed the required property code from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property code from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property message from the response with the 500 status
  response-required-property-removed
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 400
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 401
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 403
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 404
  response-media-type-name-specialized
- ○
  media type application/json was changed to a more specific media type application/problem+json for the response status 500
  response-media-type-name-specialized
- ○
  added the required property detail to the response with the 400 status
  response-required-property-added
- ○
  added the required property detail to the response with the 401 status
  response-required-property-added
- ○
  added the required property detail to the response with the 403 status
  response-required-property-added
- ○
  added the required property detail to the response with the 404 status
  response-required-property-added
- ○
  added the required property detail to the response with the 500 status
  response-required-property-added
- ○
  added the required property status to the response with the 400 status
  response-required-property-added
- ○
  added the required property status to the response with the 401 status
  response-required-property-added
- ○
  added the required property status to the response with the 403 status
  response-required-property-added
- ○
  added the required property status to the response with the 404 status
  response-required-property-added
- ○
  added the required property status to the response with the 500 status
  response-required-property-added
- ○
  added the required property title to the response with the 400 status
  response-required-property-added
- ○
  added the required property title to the response with the 401 status
  response-required-property-added
- ○
  added the required property title to the response with the 403 status
  response-required-property-added
- ○
  added the required property title to the response with the 404 status
  response-required-property-added
- ○
  added the required property title to the response with the 500 status
  response-required-property-added
- ○
  added the required property type to the response with the 400 status
  response-required-property-added
- ○
  added the required property type to the response with the 401 status
  response-required-property-added
- ○
  added the required property type to the response with the 403 status
  response-required-property-added
- ○
  added the required property type to the response with the 404 status
  response-required-property-added
- ○
  added the required property type to the response with the 500 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 29, 2026c65f43c5ad905See the full diff
- ●
  removed the optional property details from the response with the 400 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 401 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 403 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 404 status
  response-optional-property-removed
- ●
  removed the optional property details from the response with the 500 status
  response-optional-property-removed
Jun 25, 2026f89b4f376e9415See the full diff
- ○
  added the optional property details/items/debug to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details/items/debug to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details/items/type to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details/items/value to the response with the 500 status
  response-optional-property-added
Jun 25, 202690671617b825155See the full diff
- ▲
  the code response's property type/format changed from number/ to string/ for status 400
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 401
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 403
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 404
  response-property-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 500
  response-property-type-changed
- ▲
  removed the required property error from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property error from the response with the 500 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 400 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 401 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 403 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 404 status
  response-required-property-removed
- ▲
  removed the required property timestamp from the response with the 500 status
  response-required-property-removed
- ○
  added the optional property details to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property details to the response with the 500 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
May 18, 20264f143792edeb41See the full diff
- ●
  added the new authorization_token.created enum value to the category response property for the response status 200
  response-property-enum-value-added
- ●
  added the new authorization_token.updated enum value to the category response property for the response status 200
  response-property-enum-value-added
- ●
  added the new grant_request.created enum value to the category response property for the response status 200
  response-property-enum-value-added
- ●
  added the new grant_request.updated enum value to the category response property for the response status 200
  response-property-enum-value-added
- ○
  removed the donor_account.rejected enum value from the category response property for the response status 200
  response-property-enum-value-removed
May 15, 2026412b6fc0ed4e3See the full diff
- ○
  removed the donor_account.approved enum value from the category response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the grant.approved enum value from the category response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the grant.rejected enum value from the category response property for the response status 200
  response-property-enum-value-removed
May 8, 2026bdf7c9c5d0246See the full diff
- ●
  added the new donor_account.approved enum value to the category response property for the response status 200
  response-property-enum-value-added
- ●
  added the new donor_account.created enum value to the category response property for the response status 200
  response-property-enum-value-added
- ●
  added the new donor_account.rejected enum value to the category response property for the response status 200
  response-property-enum-value-added
- ●
  added the new donor_account.updated enum value to the category response property for the response status 200
  response-property-enum-value-added
- ●
  added the new grant.approved enum value to the category response property for the response status 200
  response-property-enum-value-added
- ●
  added the new grant.rejected enum value to the category response property for the response status 200
  response-property-enum-value-added

Full history