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.
Create an event subscription corresponding to your Chariot account.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
The request body for creating an event subscription
urlstringRequired
The webhook url where we'll send notifications.
categoryenumRequired
The category of the event. This is useful for filtering events.
signing_secretstringOptional
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.
Response
Created
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.
