The Webhook Object

class  Record {
  id: string 
  user_id: string  
  url: string  
  name: string  
  enabled: boolean  
  description?: string  
  headers: object  
  events: Event[]
}
  • id --> The id of the Webhook
  • name --> The name of the Webhook
  • url --> The url where the Webhook will notify
  • enabled --> The status of the Webhook
  • events --> The Events that will trigger that Webhook
  • description --> The description of the Webhook
  • headers --> The headers of the Webhook
  • user_id --> The id of the user that created the Webhook

Webhooks Manipulation methods

The Following HTTP Requests can be used to manipulate Webhooks:

  • Create Webhook: POST /v1/webhook
  • Update Webhook: PATCH /v1/webhook
  • Delete Webhook: POST /v1/webhook
  • Find Webhook: GET /v1/webhook
  • List Webhooks: GET /v1/webhook/list