WebhooksApi
| Method | HTTP request | Description |
|---|---|---|
| CreateWebhookUsingPOST | POST /api/web/v1/webhooks | Register a webhook |
| DeleteWebhookUsingDELETE | DELETE /api/web/v1/webhooks/{id} | Delete a webhook |
| GetWebhooksUsingGET | GET /api/web/v1/webhooks | List webhooks |
| ReadWebhookUsingGET | GET /api/web/v1/webhooks/{id} | Get a webhook by id |
| TestWebhookUsingPOST | POST /api/web/v1/webhooks/test/{id} | Test a webhook |
| UpdateWebhookUsingPUT | PUT /api/web/v1/webhooks/{id} | Update a webhook |
CreateWebhookUsingPOST
Webhook CreateWebhookUsingPOST (WebhookParms webhookParms)
Register a webhook
Register a webhook with callback URL, webhook events etc. Caller is required to have WEBHOOKS:ADD permission.
Using the CreateWebhookUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| webhookParms | 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 | - |
DeleteWebhookUsingDELETE
void DeleteWebhookUsingDELETE (string id)
Delete a webhook
Delete a registered webhook by ID. Caller is required to have WEBHOOKS:REMOVE permission.
Example
Using the DeleteWebhookUsingDELETEWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | 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 | - |
GetWebhooksUsingGET
List<Webhook> GetWebhooksUsingGET ()
List webhooks
Return a list of webhooks. Caller is required to have WEBHOOKS:VIEW permission.
Example
Using the GetWebhooksUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
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 | - |
ReadWebhookUsingGET
Webhook ReadWebhookUsingGET (string id)
Get a webhook by id
Get the specified webhook. Caller is required to have WEBHOOKS:VIEW permission.
Example
Using the ReadWebhookUsingGETWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | 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 | - |
TestWebhookUsingPOST
void TestWebhookUsingPOST (string 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
Using the TestWebhookUsingPOSTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | 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 | - |
UpdateWebhookUsingPUT
Webhook UpdateWebhookUsingPUT (string id, WebhookParms webhookParms)
Update a webhook
Update a webhook with callback URL, webhook events etc. Caller is required to have WEBHOOKS:EDIT permission.
Example
Using the UpdateWebhookUsingPUTWithHttpInfo variant
This returns an ApiResponse object which contains the response data, status code and headers.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | The UUID of the webhook to be updated. | |
| webhookParms | 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 | - |