Get Webhook log

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.

Get webhook logs by specifying webhookId, optional page and limit. If webhookId does not exist, no error message is returned

Method name

ManagementClient.getWebhookLogs

Request parameters

Name	Type	Required	Default value	Description	Sample value
webhookId	string	yes	-	Webhook ID	6229ffaxxxxxxxxcade3e3d9
page	number	no	1	Current page number, starting from 1	1
limit	number	no	10	The maximum number of pages per page cannot exceed 50, and the default is 10	10

Sample code

import { ManagementClient, Models } from "authing-node-sdk";

// Initialize ManagementClient
const managementClient = new ManagementClient({
  // Need to be replaced with your GenAuth Access Key ID
  accessKeyId: "GEN_AUTH_ACCESS_KEY_ID",
  // Need to be replaced with your GenAuth Access Key Secret
  accessKeySecret: "GEN_AUTH_ACCESS_KEY_SECRET",
  // If it is a private deployment customer, you need to set the GenAuth service domain name
  // host: 'https://api.your-authing-service.com'
});

(async () => {
  const result = await managementClient.getWebhookLogs({
    page: 1,
    limit: 10,
    webhookId: "6229ffaxxxxxxxxcade3e3d9",
  });

  console.log(JSON.stringify(result, null, 2));
})();

Request response

Type: ListWebhookLogsRespDto

Name	Type	Description
statusCode	number	Business status code, which can be used to determine whether the operation is successful. 200 means success.
message	string	Description
apiCode	number	Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, see: API Code List
requestId	string	Request ID. Returned when the request fails.
data	<a ListWebhookLogsData	Response data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "totalCount": 1,
    "list": {
      "webhookId": "6229ffaxxxxxxxxcade3e3d9",
      "eventName": "user:created",
      "requestBody": {
        "eventName": "test",
        "data": {
          "description": "A test from authing"
        }
      },
      "requestHeaders": {
        "eventName": "test",
        "data": {
          "description": "A test from authing"
        }
      },
      "responseStatusCode": 200,
      "responseHeaders": {
        "Accept": "application/json, text/plain, */*",
        "user-agent": "authing-webhook@2.0",
        "x-authing-token": "a",
        "x-authing-webhook-secret": "a"
      },
      "responseBody": { "success": true },
      "timestamp": "2022-09-20T08:55:00.188+0800",
      "success": true,
      "errorMessage": "ERRTIMEOUT"
    }
  }
}

Data structure

ListWebhookLogsData

Name	Type	Is it required?	Description	Sample value
totalCount	number	yes	Total number of records	1
list	array	yes	Return list Nested type: <a WebhookLogDto。

WebhookLogDto

Name	Type	Required	Description	Sample value
webhookId	string	Yes	Webhook ID	6229ffaxxxxxxxxcade3e3d9
eventName	string	Yes	Webhook event name	user:created
requestBody	object	Yes	Webhook request body	{"eventName":"test","data":{"description":"A test from authing"}}
requestHeaders	object	yes	Webhook request headers	{"eventName":"test","data":{"description":"A test from authing"}}
responseStatusCode	number	yes	Webhook response code	200
responseHeaders	object	yes	Webhook response headers	{"Accept":"application/json, text/plain, */*","user-agent":"authing-webhook@2.0","x-authing-token":"a","x-authing-webhook-secret":"a"}
responseBody	object	yes	Webhook response body	{"success":true}
timestamp	string	yes	timestamp	2022-09-20T08:55:00.188+0800
success	boolean	Yes	Is the request successful?	true
errorMessage	string	No	Error message returned when the request fails	ERRTIMEOUT