Create an Event Subscription
Create an event subscription corresponding to your Chariot account.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
This endpoint expects an object.
url
The webhook url where we'll send notifications.
category
The category of the event. This is useful for filtering events.
signingSecret
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
url
The webhook url where we'll send notifications.
id
The unique identifier for the event subscription
created_at
The date and time the event subscription was created
status
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:
category
The category of the event. This is useful for filtering events.