Sign in

v49

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-294147162.3 KB
Event Subscriptions

Create an Event Subscription

Create an event subscription corresponding to your Chariot account.

post/v1/event_subscriptions

Request body

urlstring required

The webhook url where we'll send notifications.

category'grant.created' | 'grant.updated' | 'unintegrated_grant.created' | 'unintegrated_grant.updated' | 'disbursement.created' | 'disbursement.updated' | 'inbound_transfer.created' | 'inbound_transfer.updated' required

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

signing_secretstring

The key that will be used to sign webhooks. If no value is passed, a random string will be used as default. This is necessary to verify that the webhook is coming from Chariot. While this parameter is optional, it is highly recommended to pass a value for the secret and implement webhook signature verification.

Example request

{
  "url": "https://example.com/webhook"
}

Response

Created

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.

category'grant.created' | 'grant.updated' | 'unintegrated_grant.created' | 'unintegrated_grant.updated' | 'disbursement.created' | 'disbursement.updated' | 'inbound_transfer.created' | 'inbound_transfer.updated'

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

Example response

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