1. Development Integration
  2. /
  3. SDK
  4. /
  5. Java
  6. /

  7. Management module

  8. /

  9. Manage Webhook

  10. /
  11. Manually trigger Webhook execution

Manually trigger Webhook execution

Update time: 2025-07-23 07:34:21
Edit

This document is automatically generated based on https://github.com/authing/authing-docs-factory based on https://api-explorer.genauth.ai V3 API, and is consistent with API parameters and return results. If the description of this document is incorrect, please refer to V3 API.

Manually trigger webhook execution by specifying webhookId, optional request headers and request body

Method Name

ManagementClient.triggerWebhook

Request Parameters

NameType
Is it required
Default Value
Description
Example Value
webhookIdstringyes-Webhook ID6229ffaxxxxxxxxcade3e3d9
requestHeadersobjectno-Request Headers{"eventName":"test","data":{"description":"A test from authing"}}
requestBodyobjectNo-Request body{"eventName":"test","data":{"description":"A test from authing"}}

Sample Code

package test.management;

import cn.authing.sdk.java.client.ManagementClient;
import cn.authing.sdk.java.dto.CostGetCurrentUsageRespDto;
import cn.authing.sdk.java.dto.TriggerWebhookDto;
import cn.authing.sdk.java.dto.TriggerWebhookRespDto;
import cn.authing.sdk.java.model.ManagementClientOptions;
import cn.authing.sdk.java.util.JsonUtils;

public class TriggerWebhookTest {
    // Need to be replaced with your GenAuth Access Key ID
    private static final String ACCESS_KEY_ID = "AUTHING_ACCESS_KEY_ID";
    // Need to be replaced with your GenAuth Access Key Secret
    private static final String ACCESS_KEY_SECRET = "AUTHING_ACCESS_KEY_SECRET";

    public static void main(String[] args) throws Throwable {
        ManagementClientOptions clientOptions = new ManagementClientOptions();
        clientOptions.setAccessKeyId(ACCESS_KEY_ID);
        clientOptions.setAccessKeySecret(ACCESS_KEY_SECRET);
        // If you are a private deployment customer, you need to set the GenAuth service domain name
        // clientOptions.setHost("https://api.your-authing-service.com");

        ManagementClient client = new ManagementClient(clientOptions);

        TriggerWebhookDto triggerWebhookDto = new TriggerWebhookDto();
        triggerWebhookDto.setWebhookId("AUTHING_WEBHOOK_ID");
        TriggerWebhookRespDto triggerWebhookRespDto = client.triggerWebhook(triggerWebhookDto);
        System.out.println(JsonUtils.serialize(triggerWebhookRespDto));
    }
}

Request Response

Type： TriggerWebhookRespDto

NameTypeDescription
statusCodenumberBusiness status code. You can use this status code to determine whether the operation is successful. 200 means success.
messagestringDescription
apiCodenumberSegment error code, through which the specific error type can be obtained (not returned for successful requests). For a detailed list of error codes, see：API Code List (opens new window)
requestIdstringRequest ID. Returned when the request fails.
dataTriggerWebhookDataResponse data

Example Results：

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "response": {}
  }
}

Data Structure

TriggerWebhookData

NameType
Is it required
Description
Example Value
responseYesThe original response data returned by the interface is nested Type：Any。

Any

NameType
Is it required
Description
Example Value