NEnetcorecloud
Webhook Management

Update Webhook Configuration

Use this API to create or update webhook configurations.
Set the webhook URL, custom headers, and alert email settings.

Limits

  • Up to 3 incoming and 5 event webhooks.
post/v3/metainfo/webhook/update_webhook

Request

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

Headers

Content-Typestring required
Example:application/json

Set to application/json for all requests with JSON bodies.

Request body

type'incoming' | 'event' required

Select whether the webhook is for incoming messages or event delivery.

namestring required

Enter a unique name for the webhook.

urlstring uri required

Enter the destination URL to receive webhook payloads.

sourcestring

Optionally specify the source or service that owns the webhook.

headersstring required

Provide custom headers in JSON format for webhook requests.

Example request

{
  "type": "incoming",
  "name": "ChatBot_Webhook",
  "url": "https://api.example.com/webhook/incoming",
  "source": "ChatBot_Service",
  "headers": "{\"Content-Type\": \"application/json\"}"
}

Response

Success Response

Webhook configuration updated successfully.

{
  "status": "success",
  "message": "Webhook updated successfully.",
  "data": {
    "webhook_name": "ChatBot_Webhook",
    "type": "incoming"
  }
}
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.