WebhooksApi
| Method | HTTP request | Description |
|---|---|---|
| create_webhook_using_post | POST /api/web/v1/webhooks | Register a webhook |
| delete_webhook_using_delete | DELETE /api/web/v1/webhooks/{id} | Delete a webhook |
| get_webhooks_using_get | GET /api/web/v1/webhooks | List webhooks |
| read_webhook_using_get | GET /api/web/v1/webhooks/{id} | Get a webhook by id |
| test_webhook_using_post | POST /api/web/v1/webhooks/test/{id} | Test a webhook |
| update_webhook_using_put | PUT /api/web/v1/webhooks/{id} | Update a webhook |
create_webhook_using_post
Webhook create_webhook_using_post(webhook_parms)
Register a webhook
Register a webhook with callback URL, webhook events etc. Caller is required to have WEBHOOKS:ADD permission.
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| webhook_parms | WebhookParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
delete_webhook_using_delete
delete_webhook_using_delete(id)
Delete a webhook
Delete a registered webhook by ID. Caller is required to have WEBHOOKS:REMOVE permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the webhook to be deleted. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
get_webhooks_using_get
List[Webhook] get_webhooks_using_get()
List webhooks
Return a list of webhooks. Caller is required to have WEBHOOKS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
read_webhook_using_get
Webhook read_webhook_using_get(id)
Get a webhook by id
Get the specified webhook. Caller is required to have WEBHOOKS:VIEW permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the webhook. |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
test_webhook_using_post
test_webhook_using_post(id)
Test a webhook
Sends a dummy payload to the registered webhook callback URL. Use this to ensure your API is ready to start accepting webhook notifications. Caller is required to have WEBHOOKS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the webhook to test. |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |
update_webhook_using_put
Webhook update_webhook_using_put(id, webhook_parms)
Update a webhook
Update a webhook with callback URL, webhook events etc. Caller is required to have WEBHOOKS:EDIT permission.
Example
- Api Key Authentication (AdminAPIAuthentication):
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | str | The UUID of the webhook to be updated. | |
| webhook_parms | WebhookParms |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | Successful | - |
| 400 | Bad Request | - |
| 401 | Access denied | - |
| 403 | Forbidden | - |
| 404 | Not Found | - |
| 409 | Conflict | - |