Class WebhooksApi
- java.lang.Object
-
- com.configcat.publicapi.java.client.api.WebhooksApi
-
public class WebhooksApi extends java.lang.Object
-
-
Constructor Summary
Constructors Constructor Description WebhooksApi()WebhooksApi(ApiClient apiClient)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description WebhookResponseModelcreateWebhook(java.util.UUID configId, java.util.UUID environmentId, WebHookRequestModel webHookRequestModel)Create Webhook This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.okhttp3.CallcreateWebhookAsync(java.util.UUID configId, java.util.UUID environmentId, WebHookRequestModel webHookRequestModel, ApiCallback<WebhookResponseModel> _callback)Create Webhook (asynchronously) This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.okhttp3.CallcreateWebhookCall(java.util.UUID configId, java.util.UUID environmentId, WebHookRequestModel webHookRequestModel, ApiCallback _callback)Build call for createWebhookApiResponse<WebhookResponseModel>createWebhookWithHttpInfo(java.util.UUID configId, java.util.UUID environmentId, WebHookRequestModel webHookRequestModel)Create Webhook This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.voiddeleteWebhook(java.lang.Integer webhookId)Delete Webhook This endpoint removes a Webhook identified by the `webhookId` parameter.okhttp3.CalldeleteWebhookAsync(java.lang.Integer webhookId, ApiCallback<java.lang.Void> _callback)Delete Webhook (asynchronously) This endpoint removes a Webhook identified by the `webhookId` parameter.okhttp3.CalldeleteWebhookCall(java.lang.Integer webhookId, ApiCallback _callback)Build call for deleteWebhookApiResponse<java.lang.Void>deleteWebhookWithHttpInfo(java.lang.Integer webhookId)Delete Webhook This endpoint removes a Webhook identified by the `webhookId` parameter.ApiClientgetApiClient()java.lang.StringgetCustomBaseUrl()intgetHostIndex()WebhookResponseModelgetWebhook(java.lang.Integer webhookId)Get Webhook This endpoint returns the metadata of a Webhook identified by the `webhookId`.okhttp3.CallgetWebhookAsync(java.lang.Integer webhookId, ApiCallback<WebhookResponseModel> _callback)Get Webhook (asynchronously) This endpoint returns the metadata of a Webhook identified by the `webhookId`.okhttp3.CallgetWebhookCall(java.lang.Integer webhookId, ApiCallback _callback)Build call for getWebhookjava.util.List<WebhookResponseModel>getWebhooks(java.util.UUID productId)List Webhooks This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.okhttp3.CallgetWebhooksAsync(java.util.UUID productId, ApiCallback<java.util.List<WebhookResponseModel>> _callback)List Webhooks (asynchronously) This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.okhttp3.CallgetWebhooksCall(java.util.UUID productId, ApiCallback _callback)Build call for getWebhooksWebhookSigningKeysModelgetWebhookSigningKeys(java.lang.Integer webhookId)Get Webhook Signing Keys This endpoint returns the signing keys of a Webhook identified by the `webhookId`.okhttp3.CallgetWebhookSigningKeysAsync(java.lang.Integer webhookId, ApiCallback<WebhookSigningKeysModel> _callback)Get Webhook Signing Keys (asynchronously) This endpoint returns the signing keys of a Webhook identified by the `webhookId`.okhttp3.CallgetWebhookSigningKeysCall(java.lang.Integer webhookId, ApiCallback _callback)Build call for getWebhookSigningKeysApiResponse<WebhookSigningKeysModel>getWebhookSigningKeysWithHttpInfo(java.lang.Integer webhookId)Get Webhook Signing Keys This endpoint returns the signing keys of a Webhook identified by the `webhookId`.ApiResponse<java.util.List<WebhookResponseModel>>getWebhooksWithHttpInfo(java.util.UUID productId)List Webhooks This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.ApiResponse<WebhookResponseModel>getWebhookWithHttpInfo(java.lang.Integer webhookId)Get Webhook This endpoint returns the metadata of a Webhook identified by the `webhookId`.WebhookResponseModelreplaceWebhook(java.lang.Integer webhookId, WebHookRequestModel webHookRequestModel)Replace Webhook This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter.okhttp3.CallreplaceWebhookAsync(java.lang.Integer webhookId, WebHookRequestModel webHookRequestModel, ApiCallback<WebhookResponseModel> _callback)Replace Webhook (asynchronously) This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter.okhttp3.CallreplaceWebhookCall(java.lang.Integer webhookId, WebHookRequestModel webHookRequestModel, ApiCallback _callback)Build call for replaceWebhookApiResponse<WebhookResponseModel>replaceWebhookWithHttpInfo(java.lang.Integer webhookId, WebHookRequestModel webHookRequestModel)Replace Webhook This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter.voidsetApiClient(ApiClient apiClient)voidsetCustomBaseUrl(java.lang.String customBaseUrl)voidsetHostIndex(int hostIndex)WebhookResponseModelupdateWebhook(java.lang.Integer webhookId, java.util.List<JsonPatchOperation> jsonPatchOperation)Update Webhook This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations.okhttp3.CallupdateWebhookAsync(java.lang.Integer webhookId, java.util.List<JsonPatchOperation> jsonPatchOperation, ApiCallback<WebhookResponseModel> _callback)Update Webhook (asynchronously) This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations.okhttp3.CallupdateWebhookCall(java.lang.Integer webhookId, java.util.List<JsonPatchOperation> jsonPatchOperation, ApiCallback _callback)Build call for updateWebhookApiResponse<WebhookResponseModel>updateWebhookWithHttpInfo(java.lang.Integer webhookId, java.util.List<JsonPatchOperation> jsonPatchOperation)Update Webhook This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations.
-
-
-
Constructor Detail
-
WebhooksApi
public WebhooksApi()
-
WebhooksApi
public WebhooksApi(ApiClient apiClient)
-
-
Method Detail
-
getApiClient
public ApiClient getApiClient()
-
setApiClient
public void setApiClient(ApiClient apiClient)
-
getHostIndex
public int getHostIndex()
-
setHostIndex
public void setHostIndex(int hostIndex)
-
getCustomBaseUrl
public java.lang.String getCustomBaseUrl()
-
setCustomBaseUrl
public void setCustomBaseUrl(java.lang.String customBaseUrl)
-
createWebhookCall
public okhttp3.Call createWebhookCall(java.util.UUID configId, java.util.UUID environmentId, WebHookRequestModel webHookRequestModel, ApiCallback _callback) throws ApiExceptionBuild call for createWebhook- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)webHookRequestModel- (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 201 When the creation was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
createWebhook
public WebhookResponseModel createWebhook(java.util.UUID configId, java.util.UUID environmentId, WebHookRequestModel webHookRequestModel) throws ApiException
Create Webhook This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)webHookRequestModel- (required)- Returns:
- WebhookResponseModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 201 When the creation was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
createWebhookWithHttpInfo
public ApiResponse<WebhookResponseModel> createWebhookWithHttpInfo(java.util.UUID configId, java.util.UUID environmentId, WebHookRequestModel webHookRequestModel) throws ApiException
Create Webhook This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)webHookRequestModel- (required)- Returns:
- ApiResponse<WebhookResponseModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 201 When the creation was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
createWebhookAsync
public okhttp3.Call createWebhookAsync(java.util.UUID configId, java.util.UUID environmentId, WebHookRequestModel webHookRequestModel, ApiCallback<WebhookResponseModel> _callback) throws ApiExceptionCreate Webhook (asynchronously) This endpoint creates a new Webhook in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.- Parameters:
configId- The identifier of the Config. (required)environmentId- The identifier of the Environment. (required)webHookRequestModel- (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details
Status Code Description Response Headers 201 When the creation was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
deleteWebhookCall
public okhttp3.Call deleteWebhookCall(java.lang.Integer webhookId, ApiCallback _callback) throws ApiExceptionBuild call for deleteWebhook- Parameters:
webhookId- The identifier of the Webhook. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 204 When the delete was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
deleteWebhook
public void deleteWebhook(java.lang.Integer webhookId) throws ApiExceptionDelete Webhook This endpoint removes a Webhook identified by the `webhookId` parameter.- Parameters:
webhookId- The identifier of the Webhook. (required)- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 204 When the delete was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
deleteWebhookWithHttpInfo
public ApiResponse<java.lang.Void> deleteWebhookWithHttpInfo(java.lang.Integer webhookId) throws ApiException
Delete Webhook This endpoint removes a Webhook identified by the `webhookId` parameter.- Parameters:
webhookId- The identifier of the Webhook. (required)- Returns:
- ApiResponse<Void>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 204 When the delete was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
deleteWebhookAsync
public okhttp3.Call deleteWebhookAsync(java.lang.Integer webhookId, ApiCallback<java.lang.Void> _callback) throws ApiExceptionDelete Webhook (asynchronously) This endpoint removes a Webhook identified by the `webhookId` parameter.- Parameters:
webhookId- The identifier of the Webhook. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details
Status Code Description Response Headers 204 When the delete was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhookCall
public okhttp3.Call getWebhookCall(java.lang.Integer webhookId, ApiCallback _callback) throws ApiExceptionBuild call for getWebhook- Parameters:
webhookId- The identifier of the Webhook. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the webhook data is returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhook
public WebhookResponseModel getWebhook(java.lang.Integer webhookId) throws ApiException
Get Webhook This endpoint returns the metadata of a Webhook identified by the `webhookId`.- Parameters:
webhookId- The identifier of the Webhook. (required)- Returns:
- WebhookResponseModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the webhook data is returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhookWithHttpInfo
public ApiResponse<WebhookResponseModel> getWebhookWithHttpInfo(java.lang.Integer webhookId) throws ApiException
Get Webhook This endpoint returns the metadata of a Webhook identified by the `webhookId`.- Parameters:
webhookId- The identifier of the Webhook. (required)- Returns:
- ApiResponse<WebhookResponseModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the webhook data is returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhookAsync
public okhttp3.Call getWebhookAsync(java.lang.Integer webhookId, ApiCallback<WebhookResponseModel> _callback) throws ApiExceptionGet Webhook (asynchronously) This endpoint returns the metadata of a Webhook identified by the `webhookId`.- Parameters:
webhookId- The identifier of the Webhook. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the webhook data is returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhookSigningKeysCall
public okhttp3.Call getWebhookSigningKeysCall(java.lang.Integer webhookId, ApiCallback _callback) throws ApiExceptionBuild call for getWebhookSigningKeys- Parameters:
webhookId- The identifier of the Webhook. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the webhook signing keys are returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhookSigningKeys
public WebhookSigningKeysModel getWebhookSigningKeys(java.lang.Integer webhookId) throws ApiException
Get Webhook Signing Keys This endpoint returns the signing keys of a Webhook identified by the `webhookId`. Signing keys are used for ensuring the Webhook requests you receive are actually sent by ConfigCat. <a href=\"https://configcat.com/docs/advanced/notifications-webhooks/#verifying-webhook-requests\" target=\"_blank\" rel=\"noopener noreferrer\">Here</a> you can read more about Webhook request verification.- Parameters:
webhookId- The identifier of the Webhook. (required)- Returns:
- WebhookSigningKeysModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the webhook signing keys are returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhookSigningKeysWithHttpInfo
public ApiResponse<WebhookSigningKeysModel> getWebhookSigningKeysWithHttpInfo(java.lang.Integer webhookId) throws ApiException
Get Webhook Signing Keys This endpoint returns the signing keys of a Webhook identified by the `webhookId`. Signing keys are used for ensuring the Webhook requests you receive are actually sent by ConfigCat. <a href=\"https://configcat.com/docs/advanced/notifications-webhooks/#verifying-webhook-requests\" target=\"_blank\" rel=\"noopener noreferrer\">Here</a> you can read more about Webhook request verification.- Parameters:
webhookId- The identifier of the Webhook. (required)- Returns:
- ApiResponse<WebhookSigningKeysModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the webhook signing keys are returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhookSigningKeysAsync
public okhttp3.Call getWebhookSigningKeysAsync(java.lang.Integer webhookId, ApiCallback<WebhookSigningKeysModel> _callback) throws ApiExceptionGet Webhook Signing Keys (asynchronously) This endpoint returns the signing keys of a Webhook identified by the `webhookId`. Signing keys are used for ensuring the Webhook requests you receive are actually sent by ConfigCat. <a href=\"https://configcat.com/docs/advanced/notifications-webhooks/#verifying-webhook-requests\" target=\"_blank\" rel=\"noopener noreferrer\">Here</a> you can read more about Webhook request verification.- Parameters:
webhookId- The identifier of the Webhook. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details
Status Code Description Response Headers 200 When everything is ok, the webhook signing keys are returned. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhooksCall
public okhttp3.Call getWebhooksCall(java.util.UUID productId, ApiCallback _callback) throws ApiExceptionBuild call for getWebhooks- Parameters:
productId- The identifier of the Product. (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhooks
public java.util.List<WebhookResponseModel> getWebhooks(java.util.UUID productId) throws ApiException
List Webhooks This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.- Parameters:
productId- The identifier of the Product. (required)- Returns:
- List<WebhookResponseModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhooksWithHttpInfo
public ApiResponse<java.util.List<WebhookResponseModel>> getWebhooksWithHttpInfo(java.util.UUID productId) throws ApiException
List Webhooks This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.- Parameters:
productId- The identifier of the Product. (required)- Returns:
- ApiResponse<List<WebhookResponseModel>>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
getWebhooksAsync
public okhttp3.Call getWebhooksAsync(java.util.UUID productId, ApiCallback<java.util.List<WebhookResponseModel>> _callback) throws ApiExceptionList Webhooks (asynchronously) This endpoint returns the list of the Webhooks that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.- Parameters:
productId- The identifier of the Product. (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details
Status Code Description Response Headers 200 - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
replaceWebhookCall
public okhttp3.Call replaceWebhookCall(java.lang.Integer webhookId, WebHookRequestModel webHookRequestModel, ApiCallback _callback) throws ApiExceptionBuild call for replaceWebhook- Parameters:
webhookId- The identifier of the Webhook. (required)webHookRequestModel- (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 When the replace was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
replaceWebhook
public WebhookResponseModel replaceWebhook(java.lang.Integer webhookId, WebHookRequestModel webHookRequestModel) throws ApiException
Replace Webhook This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.- Parameters:
webhookId- The identifier of the Webhook. (required)webHookRequestModel- (required)- Returns:
- WebhookResponseModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When the replace was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
replaceWebhookWithHttpInfo
public ApiResponse<WebhookResponseModel> replaceWebhookWithHttpInfo(java.lang.Integer webhookId, WebHookRequestModel webHookRequestModel) throws ApiException
Replace Webhook This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.- Parameters:
webhookId- The identifier of the Webhook. (required)webHookRequestModel- (required)- Returns:
- ApiResponse<WebhookResponseModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When the replace was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
replaceWebhookAsync
public okhttp3.Call replaceWebhookAsync(java.lang.Integer webhookId, WebHookRequestModel webHookRequestModel, ApiCallback<WebhookResponseModel> _callback) throws ApiExceptionReplace Webhook (asynchronously) This endpoint replaces the whole value of a Webhook identified by the `webhookId` parameter. **Important:** As this endpoint is doing a complete replace, it's important to set every other attribute that you don't want to change in its original state. Not listing one means it will reset.- Parameters:
webhookId- The identifier of the Webhook. (required)webHookRequestModel- (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details
Status Code Description Response Headers 200 When the replace was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
updateWebhookCall
public okhttp3.Call updateWebhookCall(java.lang.Integer webhookId, java.util.List<JsonPatchOperation> jsonPatchOperation, ApiCallback _callback) throws ApiExceptionBuild call for updateWebhook- Parameters:
webhookId- The identifier of the Webhook. (required)jsonPatchOperation- (required)_callback- Callback for upload/download progress- Returns:
- Call to execute
- Throws:
ApiException- If fail to serialize the request body object- Http Response Details
Status Code Description Response Headers 200 When the update was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
updateWebhook
public WebhookResponseModel updateWebhook(java.lang.Integer webhookId, java.util.List<JsonPatchOperation> jsonPatchOperation) throws ApiException
Update Webhook This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. For example: We have the following resource. ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"null\", \"webHookHeaders\": [] } ``` If we send an update request body as below (it changes the `content` field and adds a new HTTP header): ```json [ { \"op\": \"replace\", \"path\": \"/content\", \"value\": \"Some webhook content.\" }, { \"op\": \"add\", \"path\": \"/webHookHeaders/-\", \"value\": { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\" } } ] ``` Only the `content` and `webHookHeaders` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"Some webhook content.\", \"webHookHeaders\": [ { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\", \"isSecure\": false } ] } ```- Parameters:
webhookId- The identifier of the Webhook. (required)jsonPatchOperation- (required)- Returns:
- WebhookResponseModel
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When the update was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
updateWebhookWithHttpInfo
public ApiResponse<WebhookResponseModel> updateWebhookWithHttpInfo(java.lang.Integer webhookId, java.util.List<JsonPatchOperation> jsonPatchOperation) throws ApiException
Update Webhook This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. For example: We have the following resource. ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"null\", \"webHookHeaders\": [] } ``` If we send an update request body as below (it changes the `content` field and adds a new HTTP header): ```json [ { \"op\": \"replace\", \"path\": \"/content\", \"value\": \"Some webhook content.\" }, { \"op\": \"add\", \"path\": \"/webHookHeaders/-\", \"value\": { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\" } } ] ``` Only the `content` and `webHookHeaders` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"Some webhook content.\", \"webHookHeaders\": [ { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\", \"isSecure\": false } ] } ```- Parameters:
webhookId- The identifier of the Webhook. (required)jsonPatchOperation- (required)- Returns:
- ApiResponse<WebhookResponseModel>
- Throws:
ApiException- If fail to call the API, e.g. server error or cannot deserialize the response body- Http Response Details
Status Code Description Response Headers 200 When the update was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
updateWebhookAsync
public okhttp3.Call updateWebhookAsync(java.lang.Integer webhookId, java.util.List<JsonPatchOperation> jsonPatchOperation, ApiCallback<WebhookResponseModel> _callback) throws ApiExceptionUpdate Webhook (asynchronously) This endpoint updates a Webhook identified by the `webhookId` parameter with a collection of [JSON Patch](https://jsonpatch.com) operations. The advantage of using JSON Patch is that you can describe individual update operations on a resource without touching attributes that you don't want to change. For example: We have the following resource. ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"null\", \"webHookHeaders\": [] } ``` If we send an update request body as below (it changes the `content` field and adds a new HTTP header): ```json [ { \"op\": \"replace\", \"path\": \"/content\", \"value\": \"Some webhook content.\" }, { \"op\": \"add\", \"path\": \"/webHookHeaders/-\", \"value\": { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\" } } ] ``` Only the `content` and `webHookHeaders` are updated and all the other attributes remain unchanged. So we get a response like this: ```json { \"webhookId\": 6, \"url\": \"https://example.com/hook\", \"httpMethod\": \"post\", \"content\": \"Some webhook content.\", \"webHookHeaders\": [ { \"key\": \"X-Custom-Header\", \"value\": \"Custom header value\", \"isSecure\": false } ] } ```- Parameters:
webhookId- The identifier of the Webhook. (required)jsonPatchOperation- (required)_callback- The callback to be executed when the API call finishes- Returns:
- The request call
- Throws:
ApiException- If fail to process the API call, e.g. serializing the request body object- Http Response Details
Status Code Description Response Headers 200 When the update was successful. - 400 Bad request. - 404 Not found. - 429 Too many requests. In case of the request rate exceeds the rate limits. -
-
-