Skip to content

webhooks.md

Latest commit

 

History

History
214 lines (142 loc) · 5.3 KB

webhooks.md

File metadata and controls

214 lines (142 loc) · 5.3 KB
Raw

Webhooks

6 operation(s). Part of the API index.

Call these as client.<service>.<method>(...). <service> is the client field for this group — the README lists the field name for every service. These pages group operations the way the OpenAPI specification tags them, which is not always one field per page.

createWebhookConfiguration

POST /v2/manage/webhooks

Create webhook configuration

Creates a new webhook configuration for the Tenant, allowing registration of a webhook with details such as the Target URL and subscribed events.

Example

public static void callCreateWebhookConfiguration(LoginRadiusClient client) {
  WebhookSubscriptionCreateModel webhookSubscriptionCreateModel = new WebhookSubscriptionCreateModel().event("<event>").targetUrl("<targetUrl>"); //Optional

  try {
    var response = client.webhooks.createWebhookConfiguration(webhookSubscriptionCreateModel);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Request body

WebhookSubscriptionCreateModel as application/json.

Returns

WebhookSubscription

deleteWebhookConfigurationById

DELETE /v2/manage/webhooks/{hookId}

Delete webhook configuration

Deletes a specific webhook configuration for the Tenant using its unique ID, permanently removing the webhook from receiving further event notifications.

Example

public static void callDeleteWebhookConfigurationById(LoginRadiusClient client) {
  String hookId = "<hookId>"; //Required

  try {
    var response = client.webhooks.deleteWebhookConfigurationById(hookId);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
hookId path string yes Webhook ID

Returns

DeleteResponse

getAllEvents

GET /v2/manage/webhooks/events

List webhook events

Retrieves a list of all available webhook events that can be subscribed to by the Tenant for configuring webhooks to receive notifications for specific activities.

Example

public static void callGetAllEvents(LoginRadiusClient client) {
  try {
    var response = client.webhooks.getAllEvents();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

WebhookEvents

getAllWebhooksConfigurations

GET /v2/manage/webhooks

List webhook configurations

Retrieves a list of all configured webhooks for the Tenant, including detailed information about each webhook and its subscribed events.

Example

public static void callGetAllWebhooksConfigurations(LoginRadiusClient client) {
  try {
    var response = client.webhooks.getAllWebhooksConfigurations();
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Returns

WebhookSubscriptionResponse

getWebhookConfigurationById

GET /v2/manage/webhooks/{hookId}

Retrieve webhook configuration

Retrieves the details of a specific webhook configuration for the Tenant by its unique ID, including the Target URL, subscribed events, and other settings.

Example

public static void callGetWebhookConfigurationById(LoginRadiusClient client) {
  String hookId = "<hookId>"; //Required

  try {
    var response = client.webhooks.getWebhookConfigurationById(hookId);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
hookId path string yes Webhook ID

Returns

WebhookSubscription

updateWebhookConfigurationById

PUT /v2/manage/webhooks/{hookId}

Update webhook configuration

Updates an existing webhook configuration for the Tenant by its unique ID, modifying details such as the Target URL, subscribed events, or other settings.

Example

public static void callUpdateWebhookConfigurationById(LoginRadiusClient client) {
  String hookId = "<hookId>"; //Required
  WebhookSubscriptionUpdateModel webhookSubscriptionUpdateModel = new WebhookSubscriptionUpdateModel().targetUrl("<targetUrl>"); //Optional

  try {
    var response = client.webhooks.updateWebhookConfigurationById(hookId, webhookSubscriptionUpdateModel);
    System.out.println(response);
  } catch (ApiException e) {
    LoginRadiusException lr = LoginRadiusClient.toLoginRadiusException(e);
    System.err.println(lr.description());
  }
}

Parameters

Name In Type Required Description
hookId path string yes Webhook ID

Request body

WebhookSubscriptionUpdateModel as application/json.

Returns

WebhookSubscription