Sign in
Events

Get Event

Retrieve an event with the given ID.

get/v1/events/{id}

Path parameters

idstring required

The unique id for the event

Response

OK

idstring

The unique identifier for the event

category'grant.created' | 'grant.updated' | 'unintegrated_grant.created' | 'unintegrated_grant.updated' | 'donor_account.created' | 'donor_account.updated' | 'authorization_token.created' | 'authorization_token.updated' | 'grant_request.created' | 'grant_request.updated' | 'disbursement.created' | 'disbursement.updated' | 'inbound_transfer.created' | 'inbound_transfer.updated' | 'donation.created' | 'donation.updated' | 'deposit.created' | 'deposit.updated' | 'verification_request.created' | 'verification_request.updated'

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.

created_atstring date-time

The date and time the event was created

associated_object_idstring

The unique identifier for the associated object

associated_object_typestring

The type of the associated object

Example response

{
  "id": "203c4e56-5c39-4a66-abcd-2ec8af99a1b9",
  "created_at": "2024-01-19T18:48:56.37Z",
  "associated_object_id": "4d06d393-1f14-46cf-b02d-8db17d7ed06a",
  "associated_object_type": "grant"
}

Changes

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

  • b87f7738d3361025See 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

  • c65f43c5ad905See 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

  • f89b4f376e9415See 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

  • 90671617b825155See 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

  • 4f143792edeb41See 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

  • 412b6fc0ed4e3See 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

  • bdf7c9c5d0246See 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