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

  7. Management Module

  8. /

  9. 管理 Webhook

  10. /
  11. 修改 Webhook 配置

Modify Webhook configuration

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.

Need to specify webhookId, optional webhook name, webhook callback address, request data format, user real name, whether to enable, request key parameters to modify webhook

Method name

ManagementClient.update_webhook

Request parameters

NameType
Required
Default value
Description
Sample value
webhookIdstringYes-Webhook ID6229ffaxxxxxxxxcade3e3d9
namestringNo-Webhook nameUser created event
urlstringNo-Webhook callback addresshttps://example.com/callback
eventsstring[]No-User's real name, not unique. Example value: Zhang San["user:created"]
contentTypestringNo-Request data formatapplication/json
enabledbooleanNo-Enabledtrue
secretstringNo-Request keyxxxxxxxxxxxx

Request response

Type: UpdateWebhooksRespDto

NameTypeDescription
statusCodenumberBusiness status code, which can be used to determine whether the operation is successful, 200 means success.
messagestringDescription
apiCodenumberSegmented error code, which can be used to get the specific error type (successful request is not returned). For a detailed list of error codes, see: API Code List (opens new window)
requestIdstringRequest ID. Returned when the request fails.
dataWebhookDtoResponse data

Sample result:

{
  "statusCode": 200,
  "message": "Operation successful",
  "requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
  "data": {
    "webhookId": "6229ffaxxxxxxxxcade3e3d9",
    "createdAt": "2022-07-03T02:20:30.000Z",
    "updatedAt": "2022-07-03T02:20:30.000Z",
    "name": "User creation event",
    "url": "https://example.com/callback",
    "contentType": "application/json",
    "enabled": true,
    "events": "[\"user:created\"]",
    "secret": "xxxxxxxxxxxx"
  }
}

Data structure

WebhookDto

NameType
Is it required?
Description
Sample value
webhookIdstringYesWebhook ID6229ffaxxxxxxxxcade3e3d9
createdAtstringYesCreation time2022-07-03T02:20:30.000Z
updatedAtstringYesUpdate time2022-07-03T02:20:30.000Z
namestringyesWebhook nameUser created event
urlstringyesWebhook callback addresshttps://example.com/callback
contentTypestringyesRequest data formatapplication/json
enabledbooleanyesEnabled or nottrue
eventsarraynoUser's real name, not unique. Example value: Zhang San["user:created"]
secretstringnoRequest keyxxxxxxxxxxxx