Skip to main content

Enable Webhook

Enables a disabled Webhook. The request body is empty. Re-enabling does not redeliver events that occurred during the disabled period.

Prerequisites

Endpoint and authentication configured. For details, see Overview and authentication.

Endpoint

POST /webhook_endpoints/{id}/enable

Path parameters

FieldRequiredTypeDescription
idYesstringWebhook ID, format wep_<ULID>

Request example

curl -X POST "$AGENTSTUDIO_URL/webhook_endpoints/wep_01JXX7YQGPRPV1BZXA35QE7WDP/enable" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY"

Response example

{
  "id": "wep_01JXX7YQGPRPV1BZXA35QE7WDP",
  "description": "Production session events",
  "url": "https://example.com/managedagent/webhooks",
  "events": ["session.status_idled"],
  "status": "ACTIVE",
  "disabled_reason": null,
  "consecutive_fail": 2,
  "last_success_at": "2026-08-06T10:05:00Z",
  "last_failure_at": "2026-08-06T10:10:00Z",
  "created_at": "2026-08-06T10:00:00Z",
  "updated_at": "2026-08-06T10:20:00Z",
  "request_id": "8e1d16e4"
}

Response fields

FieldTypeDescription
idstringWebhook ID
descriptionstring | nullDescription
urlstringCallback URL
eventsarray<string>Subscribed named event types
statusstringAlways ACTIVE after this operation
disabled_reasonstring | nullAlways null after this operation
consecutive_failintegerCurrent consecutive failure count at the time of enable
last_success_atstring | nullLast successful delivery time at the time of enable
last_failure_atstring | nullLast failed delivery time at the time of enable
created_atstringCreation time, ISO 8601
updated_atstringLast update time, ISO 8601
request_idstringUnique request identifier

Error codes

HTTP statusError codeDescription
40411800001Webhook not found or already deleted
Flow Agent API
Sandbox API
RAG API
Long-term Memory
ParseX API
Security API
Framework Integration