HTTP Specification
For basic information about Webhooks, refer to API Basics
Webhooks
For receiving notifications on various events, a callback needs to be added which is called a webhook. The following are the supported endpoints and methods related to webhooks:
| Endpoint | Description |
|---|---|
| GET systems/:system/events/:event/hooks/:hook_id | Retrieves the detail about a webhook for a specified event. |
| GET systems/:system/events/:event/hooks | Retrieves a paginated list of all the webhooks of a specified system and event type. |
| GET systems/:system/hooks | Retrieves a paginated list of all the webhooks of a specified system. |
| GET hooks | Retrieves a paginated list of all the webhooks. |
| GET app/hooks | Retrieves a paginated list of all the webhooks created in the context of an application. |
| POST systems/:system/events/:event/hooks | Add new webhook to receive the notification on a specified event. |
| POST systems/:system/hooks | Add new webhooks to receive the notification on all the events. |
| DELETE systems/:system/events/:event/hooks/:hook_id | Deletes a webhook. |
| PATCH systems/:system/events/:event/hooks/:hook_id | Makes a partial update to an existing webhook. Allow to change webhooks status, filter, hook attributes, and hook expiry. |
Tokens
Tokens are used for authenticating client which are registered for receiving callback
| Endpoint Description | |
|---|---|
| POST tokens | Inserts a new token |
| PUT tokens/@me | Updates an existing token |
| DELETE tokens/@me | Deletes a token |
