Create an Event Subscription

POST
/v1/event_subscriptions

Create an event subscription corresponding to your Chariot account.

Request

This endpoint expects an object.
urlstringRequired

The webhook url where we’ll send notifications.

categoryenumRequired
Allowed values: grant.createdgrant.updatedunintegrated_grant.createdunintegrated_grant.updated

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

signingSecretstringOptional

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

This endpoint returns an object.
urlstring

The webhook url where we’ll send notifications.

idstringOptional

The unique identifier for the event subscription

created_atdatetimeOptional

The date and time the event subscription was created

statusenumOptional
Allowed values: activedisableddeletedrequires_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
categoryenumOptional
Allowed values: grant.createdgrant.updatedunintegrated_grant.createdunintegrated_grant.updated

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

Errors

Built with