# \WebsocketTriggerApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**create_websocket_trigger**](WebsocketTriggerApi.md#create_websocket_trigger) | **POST** /w/{workspace}/websocket_triggers/create | create websocket trigger
[**delete_websocket_trigger**](WebsocketTriggerApi.md#delete_websocket_trigger) | **DELETE** /w/{workspace}/websocket_triggers/delete/{path} | delete websocket trigger
[**exists_websocket_trigger**](WebsocketTriggerApi.md#exists_websocket_trigger) | **GET** /w/{workspace}/websocket_triggers/exists/{path} | does websocket trigger exists
[**get_websocket_trigger**](WebsocketTriggerApi.md#get_websocket_trigger) | **GET** /w/{workspace}/websocket_triggers/get/{path} | get websocket trigger
[**list_websocket_triggers**](WebsocketTriggerApi.md#list_websocket_triggers) | **GET** /w/{workspace}/websocket_triggers/list | list websocket triggers
[**set_websocket_trigger_mode**](WebsocketTriggerApi.md#set_websocket_trigger_mode) | **POST** /w/{workspace}/websocket_triggers/setmode/{path} | set enabled websocket trigger
[**test_websocket_connection**](WebsocketTriggerApi.md#test_websocket_connection) | **POST** /w/{workspace}/websocket_triggers/test | test websocket connection
[**update_websocket_trigger**](WebsocketTriggerApi.md#update_websocket_trigger) | **POST** /w/{workspace}/websocket_triggers/update/{path} | update websocket trigger



## create_websocket_trigger

> String create_websocket_trigger(workspace, new_websocket_trigger)
create websocket trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**new_websocket_trigger** | [**NewWebsocketTrigger**](NewWebsocketTrigger.md) | new websocket trigger | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_websocket_trigger

> String delete_websocket_trigger(workspace, path)
delete websocket trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## exists_websocket_trigger

> bool exists_websocket_trigger(workspace, path)
does websocket trigger exists

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

**bool**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_websocket_trigger

> models::WebsocketTrigger get_websocket_trigger(workspace, path)
get websocket trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |

### Return type

[**models::WebsocketTrigger**](WebsocketTrigger.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_websocket_triggers

> Vec<models::WebsocketTrigger> list_websocket_triggers(workspace, page, per_page, path, is_flow, path_start, label)
list websocket triggers

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**page** | Option<**i32**> | which page to return (start at 1, default 1) |  |
**per_page** | Option<**i32**> | number of items to return for a given page (default 30, max 100) |  |
**path** | Option<**String**> | filter by path |  |
**is_flow** | Option<**bool**> |  |  |
**path_start** | Option<**String**> |  |  |
**label** | Option<**String**> | Filter by label |  |

### Return type

[**Vec<models::WebsocketTrigger>**](WebsocketTrigger.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_websocket_trigger_mode

> String set_websocket_trigger_mode(workspace, path, set_http_trigger_mode_request)
set enabled websocket trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**set_http_trigger_mode_request** | [**SetHttpTriggerModeRequest**](SetHttpTriggerModeRequest.md) | updated websocket trigger enable | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## test_websocket_connection

> String test_websocket_connection(workspace, test_websocket_connection_request)
test websocket connection

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**test_websocket_connection_request** | [**TestWebsocketConnectionRequest**](TestWebsocketConnectionRequest.md) | test websocket connection | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_websocket_trigger

> String update_websocket_trigger(workspace, path, edit_websocket_trigger)
update websocket trigger

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** |  | [required] |
**edit_websocket_trigger** | [**EditWebsocketTrigger**](EditWebsocketTrigger.md) | updated trigger | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

