public class ManageWebhooksApi extends Object
| Constructor and Description |
|---|
ManageWebhooksApi() |
ManageWebhooksApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
void |
deleteWebhookSubscription(String webhookId)
Delete a Webhook Subscription
Delete the webhook.
|
okhttp3.Call |
deleteWebhookSubscriptionAsync(String webhookId,
ApiCallback<Void> callback)
Delete a Webhook Subscription (asynchronously)
Delete the webhook.
|
okhttp3.Call |
deleteWebhookSubscriptionCall(String webhookId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for deleteWebhookSubscription
|
ApiResponse<Void> |
deleteWebhookSubscriptionWithHttpInfo(String webhookId)
Delete a Webhook Subscription
Delete the webhook.
|
ApiClient |
getApiClient() |
InlineResponse2014 |
getWebhookSubscriptionById(String webhookId)
Get Details On a Single Webhook
Retrieve the details of a specific webhook by supplying the webhook ID in the path.
|
okhttp3.Call |
getWebhookSubscriptionByIdAsync(String webhookId,
ApiCallback<InlineResponse2014> callback)
Get Details On a Single Webhook (asynchronously)
Retrieve the details of a specific webhook by supplying the webhook ID in the path.
|
okhttp3.Call |
getWebhookSubscriptionByIdCall(String webhookId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getWebhookSubscriptionById
|
ApiResponse<InlineResponse2014> |
getWebhookSubscriptionByIdWithHttpInfo(String webhookId)
Get Details On a Single Webhook
Retrieve the details of a specific webhook by supplying the webhook ID in the path.
|
List<InlineResponse2004> |
getWebhookSubscriptionsByOrg(String organizationId,
String productId,
String eventType)
Get Details On All Created Webhooks
Retrieve a list of all previously created webhooks.
|
okhttp3.Call |
getWebhookSubscriptionsByOrgAsync(String organizationId,
String productId,
String eventType,
ApiCallback<List<InlineResponse2004>> callback)
Get Details On All Created Webhooks (asynchronously)
Retrieve a list of all previously created webhooks.
|
okhttp3.Call |
getWebhookSubscriptionsByOrgCall(String organizationId,
String productId,
String eventType,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for getWebhookSubscriptionsByOrg
|
ApiResponse<List<InlineResponse2004>> |
getWebhookSubscriptionsByOrgWithHttpInfo(String organizationId,
String productId,
String eventType)
Get Details On All Created Webhooks
Retrieve a list of all previously created webhooks.
|
InlineResponse2015 |
notificationSubscriptionsV1WebhooksWebhookIdPost(String webhookId)
Test a Webhook Configuration
Test the webhook configuration by sending a sample webhook.
|
okhttp3.Call |
notificationSubscriptionsV1WebhooksWebhookIdPostAsync(String webhookId,
ApiCallback<InlineResponse2015> callback)
Test a Webhook Configuration (asynchronously)
Test the webhook configuration by sending a sample webhook.
|
okhttp3.Call |
notificationSubscriptionsV1WebhooksWebhookIdPostCall(String webhookId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for notificationSubscriptionsV1WebhooksWebhookIdPost
|
ApiResponse<InlineResponse2015> |
notificationSubscriptionsV1WebhooksWebhookIdPostWithHttpInfo(String webhookId)
Test a Webhook Configuration
Test the webhook configuration by sending a sample webhook.
|
void |
notificationSubscriptionsV2WebhooksWebhookIdPatch(String webhookId,
UpdateWebhook updateWebhook)
Update a Webhook Subscription
Update a Webhook Subscription.
|
okhttp3.Call |
notificationSubscriptionsV2WebhooksWebhookIdPatchAsync(String webhookId,
UpdateWebhook updateWebhook,
ApiCallback<Void> callback)
Update a Webhook Subscription (asynchronously)
Update a Webhook Subscription.
|
okhttp3.Call |
notificationSubscriptionsV2WebhooksWebhookIdPatchCall(String webhookId,
UpdateWebhook updateWebhook,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for notificationSubscriptionsV2WebhooksWebhookIdPatch
|
ApiResponse<Void> |
notificationSubscriptionsV2WebhooksWebhookIdPatchWithHttpInfo(String webhookId,
UpdateWebhook updateWebhook)
Update a Webhook Subscription
Update a Webhook Subscription.
|
void |
notificationSubscriptionsV2WebhooksWebhookIdStatusPut(String webhookId,
UpdateStatus updateStatus)
Update a Webhook Status
Users can update the status of a webhook subscription by calling this endpoint.
|
okhttp3.Call |
notificationSubscriptionsV2WebhooksWebhookIdStatusPutAsync(String webhookId,
UpdateStatus updateStatus,
ApiCallback<Void> callback)
Update a Webhook Status (asynchronously)
Users can update the status of a webhook subscription by calling this endpoint.
|
okhttp3.Call |
notificationSubscriptionsV2WebhooksWebhookIdStatusPutCall(String webhookId,
UpdateStatus updateStatus,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for notificationSubscriptionsV2WebhooksWebhookIdStatusPut
|
ApiResponse<Void> |
notificationSubscriptionsV2WebhooksWebhookIdStatusPutWithHttpInfo(String webhookId,
UpdateStatus updateStatus)
Update a Webhook Status
Users can update the status of a webhook subscription by calling this endpoint.
|
InlineResponse2016 |
saveAsymEgressKey(String vCSenderOrganizationId,
String vCPermissions,
SaveAsymEgressKey saveAsymEgressKey,
String vCCorrelationId)
Message Level Encryption
Store and manage certificates that will be used to preform Message Level Encryption (MLE).
|
okhttp3.Call |
saveAsymEgressKeyAsync(String vCSenderOrganizationId,
String vCPermissions,
SaveAsymEgressKey saveAsymEgressKey,
String vCCorrelationId,
ApiCallback<InlineResponse2016> callback)
Message Level Encryption (asynchronously)
Store and manage certificates that will be used to preform Message Level Encryption (MLE).
|
okhttp3.Call |
saveAsymEgressKeyCall(String vCSenderOrganizationId,
String vCPermissions,
SaveAsymEgressKey saveAsymEgressKey,
String vCCorrelationId,
ProgressResponseBody.ProgressListener progressListener,
ProgressRequestBody.ProgressRequestListener progressRequestListener)
Build call for saveAsymEgressKey
|
ApiResponse<InlineResponse2016> |
saveAsymEgressKeyWithHttpInfo(String vCSenderOrganizationId,
String vCPermissions,
SaveAsymEgressKey saveAsymEgressKey,
String vCCorrelationId)
Message Level Encryption
Store and manage certificates that will be used to preform Message Level Encryption (MLE).
|
void |
setApiClient(ApiClient apiClient) |
public ManageWebhooksApi()
public ManageWebhooksApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call deleteWebhookSubscriptionCall(String webhookId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
webhookId - The webhook identifier. (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void deleteWebhookSubscription(String webhookId) throws ApiException
webhookId - The webhook identifier. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> deleteWebhookSubscriptionWithHttpInfo(String webhookId) throws ApiException
webhookId - The webhook identifier. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call deleteWebhookSubscriptionAsync(String webhookId, ApiCallback<Void> callback) throws ApiException
webhookId - The webhook identifier. (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getWebhookSubscriptionByIdCall(String webhookId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
webhookId - The webhook Identifier (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic InlineResponse2014 getWebhookSubscriptionById(String webhookId) throws ApiException
webhookId - The webhook Identifier (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<InlineResponse2014> getWebhookSubscriptionByIdWithHttpInfo(String webhookId) throws ApiException
webhookId - The webhook Identifier (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getWebhookSubscriptionByIdAsync(String webhookId, ApiCallback<InlineResponse2014> callback) throws ApiException
webhookId - The webhook Identifier (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call getWebhookSubscriptionsByOrgCall(String organizationId, String productId, String eventType, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
organizationId - The Organization Identifier. (required)productId - The Product Identifier. (optional)eventType - The Event Type. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic List<InlineResponse2004> getWebhookSubscriptionsByOrg(String organizationId, String productId, String eventType) throws ApiException
organizationId - The Organization Identifier. (required)productId - The Product Identifier. (optional)eventType - The Event Type. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<List<InlineResponse2004>> getWebhookSubscriptionsByOrgWithHttpInfo(String organizationId, String productId, String eventType) throws ApiException
organizationId - The Organization Identifier. (required)productId - The Product Identifier. (optional)eventType - The Event Type. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call getWebhookSubscriptionsByOrgAsync(String organizationId, String productId, String eventType, ApiCallback<List<InlineResponse2004>> callback) throws ApiException
organizationId - The Organization Identifier. (required)productId - The Product Identifier. (optional)eventType - The Event Type. (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call notificationSubscriptionsV1WebhooksWebhookIdPostCall(String webhookId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
webhookId - The Webhook Identifier. (required)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic InlineResponse2015 notificationSubscriptionsV1WebhooksWebhookIdPost(String webhookId) throws ApiException
webhookId - The Webhook Identifier. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<InlineResponse2015> notificationSubscriptionsV1WebhooksWebhookIdPostWithHttpInfo(String webhookId) throws ApiException
webhookId - The Webhook Identifier. (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call notificationSubscriptionsV1WebhooksWebhookIdPostAsync(String webhookId, ApiCallback<InlineResponse2015> callback) throws ApiException
webhookId - The Webhook Identifier. (required)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call notificationSubscriptionsV2WebhooksWebhookIdPatchCall(String webhookId, UpdateWebhook updateWebhook, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
webhookId - The Webhook Identifier. (required)updateWebhook - The webhook payload or changes to apply. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void notificationSubscriptionsV2WebhooksWebhookIdPatch(String webhookId, UpdateWebhook updateWebhook) throws ApiException
webhookId - The Webhook Identifier. (required)updateWebhook - The webhook payload or changes to apply. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> notificationSubscriptionsV2WebhooksWebhookIdPatchWithHttpInfo(String webhookId, UpdateWebhook updateWebhook) throws ApiException
webhookId - The Webhook Identifier. (required)updateWebhook - The webhook payload or changes to apply. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call notificationSubscriptionsV2WebhooksWebhookIdPatchAsync(String webhookId, UpdateWebhook updateWebhook, ApiCallback<Void> callback) throws ApiException
webhookId - The Webhook Identifier. (required)updateWebhook - The webhook payload or changes to apply. (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call notificationSubscriptionsV2WebhooksWebhookIdStatusPutCall(String webhookId, UpdateStatus updateStatus, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
webhookId - The Webhook Identifier. (required)updateStatus - The status that the subscription should be updated to. (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic void notificationSubscriptionsV2WebhooksWebhookIdStatusPut(String webhookId, UpdateStatus updateStatus) throws ApiException
webhookId - The Webhook Identifier. (required)updateStatus - The status that the subscription should be updated to. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<Void> notificationSubscriptionsV2WebhooksWebhookIdStatusPutWithHttpInfo(String webhookId, UpdateStatus updateStatus) throws ApiException
webhookId - The Webhook Identifier. (required)updateStatus - The status that the subscription should be updated to. (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call notificationSubscriptionsV2WebhooksWebhookIdStatusPutAsync(String webhookId, UpdateStatus updateStatus, ApiCallback<Void> callback) throws ApiException
webhookId - The Webhook Identifier. (required)updateStatus - The status that the subscription should be updated to. (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectpublic okhttp3.Call saveAsymEgressKeyCall(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId, ProgressResponseBody.ProgressListener progressListener, ProgressRequestBody.ProgressRequestListener progressRequestListener) throws ApiException
vCSenderOrganizationId - Sender organization id (required)vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required)saveAsymEgressKey - Provide egress Asymmetric key information to save (create or store) (required)vCCorrelationId - A globally unique id associated with your request (optional)progressListener - Progress listenerprogressRequestListener - Progress request listenerApiException - If fail to serialize the request body objectpublic InlineResponse2016 saveAsymEgressKey(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId) throws ApiException
vCSenderOrganizationId - Sender organization id (required)vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required)saveAsymEgressKey - Provide egress Asymmetric key information to save (create or store) (required)vCCorrelationId - A globally unique id associated with your request (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic ApiResponse<InlineResponse2016> saveAsymEgressKeyWithHttpInfo(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId) throws ApiException
vCSenderOrganizationId - Sender organization id (required)vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required)saveAsymEgressKey - Provide egress Asymmetric key information to save (create or store) (required)vCCorrelationId - A globally unique id associated with your request (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response bodypublic okhttp3.Call saveAsymEgressKeyAsync(String vCSenderOrganizationId, String vCPermissions, SaveAsymEgressKey saveAsymEgressKey, String vCCorrelationId, ApiCallback<InlineResponse2016> callback) throws ApiException
vCSenderOrganizationId - Sender organization id (required)vCPermissions - Encoded user permissions returned by the CGK, for the entity user who initiated the boarding (required)saveAsymEgressKey - Provide egress Asymmetric key information to save (create or store) (required)vCCorrelationId - A globally unique id associated with your request (optional)callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body objectCopyright © 2025. All rights reserved.