NEnetcorecloud
Webhook Management

Manage Webhook Status

Use this API to enable or disable webhook endpoints without changing their configuration.

Status Options

  • enable – Activate webhook to start receiving events.
  • disable – Temporarily pause webhook delivery.

Typical Use Cases

  • Disable webhooks during maintenance.
  • Re-enable after testing or scaling down load.
post/v2/metainfo/webhook/manage_webhook

Request

  • Base URL
    https://cpaaswa.netcorecloud.net/api
  • URL
    https://cpaaswa.netcorecloud.net/api/v2/metainfo/webhook/manage_webhook
  • Auth
    HTTP bearer

Parameters

#/paths/~1v3~1metainfo~1webhook~1update_webhook/post/parameters/0 (unresolved $ref)

Request body

type'incoming' | 'event' required

Select the webhook type you want to enable or disable.

webhook_namestring required

Enter the name of the webhook you want to manage.

status'enable' | 'disable' required

Set the new status for the webhook.

Example request

{
  "type": "incoming",
  "webhook_name": "ChatBot_Webhook",
  "status": "enable"
}

Response

Success Response

Webhook status updated successfully.

{
  "status": "success",
  "message": "Webhook status updated successfully.",
  "data": {
    "webhook_name": "ChatBot_Webhook",
    "status": "enabled"
  }
}
status'success' | 'failure' required

Indicates if the operation was successful.

messagestring required

Message describing the operation result.

Example response

{
  "status": "success",
  "message": "Webhook updated successfully.",
  "data": {
    "webhook_name": "ChatBot_Webhook",
    "type": "incoming",
    "status": "enabled"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.