Compare commits

...
Author SHA1 Message Date
Ben ff1886eeff docs(api): list all 3 supported webhook event types in CreateWebhookRequest
The event_types field description said 'Currently supported: consolidation.completed',
but the API actually emits and accepts all three events:
- retain.completed (memory_engine.py)
- consolidation.completed (memory_engine.py)
- memory_defense.triggered (retain/orchestrator.py)

Update the description accordingly and propagate through the regenerated OpenAPI
spec + the embedded copies in the go/python/typescript clients. Description-only
change; no behavior change.
2026-06-11 16:53:21 -04:00
7 changed files with 8 additions and 7 deletions
+1 -1
View File
@@ -2670,7 +2670,7 @@ class CreateWebhookRequest(BaseModel):
secret: str | None = Field(default=None, description="HMAC-SHA256 signing secret (optional)")
event_types: list[str] = Field(
default=["consolidation.completed"],
description="List of event types to deliver. Currently supported: 'consolidation.completed'",
description="List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.",
)
enabled: bool = Field(default=True, description="Whether this webhook is active")
http_config: WebhookHttpConfig = Field(
+2 -1
View File
@@ -5103,7 +5103,8 @@ components:
event_types:
default:
- consolidation.completed
description: "List of event types to deliver. Currently supported: 'consolidation.completed'"
description: "List of event types to deliver. Supported: 'retain.completed',\
\ 'consolidation.completed', 'memory_defense.triggered'."
items:
type: string
type: array
@@ -24,7 +24,7 @@ type CreateWebhookRequest struct {
// HTTP(S) endpoint URL to deliver events to
Url string `json:"url"`
Secret NullableString `json:"secret,omitempty"`
// List of event types to deliver. Currently supported: 'consolidation.completed'
// List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.
EventTypes []string `json:"event_types,omitempty"`
// Whether this webhook is active
Enabled *bool `json:"enabled,omitempty"`
@@ -29,7 +29,7 @@ class CreateWebhookRequest(BaseModel):
""" # noqa: E501
url: StrictStr = Field(description="HTTP(S) endpoint URL to deliver events to")
secret: Optional[StrictStr] = None
event_types: Optional[List[StrictStr]] = Field(default=None, description="List of event types to deliver. Currently supported: 'consolidation.completed'")
event_types: Optional[List[StrictStr]] = Field(default=None, description="List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.")
enabled: Optional[StrictBool] = Field(default=True, description="Whether this webhook is active")
http_config: Optional[WebhookHttpConfig] = Field(default=None, description="HTTP delivery configuration (method, timeout, headers, params)")
__properties: ClassVar[List[str]] = ["url", "secret", "event_types", "enabled", "http_config"]
@@ -1224,7 +1224,7 @@ export type CreateWebhookRequest = {
/**
* Event Types
*
* List of event types to deliver. Currently supported: 'consolidation.completed'
* List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.
*/
event_types?: Array<string>;
/**
+1 -1
View File
@@ -7748,7 +7748,7 @@
},
"type": "array",
"title": "Event Types",
"description": "List of event types to deliver. Currently supported: 'consolidation.completed'",
"description": "List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.",
"default": [
"consolidation.completed"
]
@@ -7748,7 +7748,7 @@
},
"type": "array",
"title": "Event Types",
"description": "List of event types to deliver. Currently supported: 'consolidation.completed'",
"description": "List of event types to deliver. Supported: 'retain.completed', 'consolidation.completed', 'memory_defense.triggered'.",
"default": [
"consolidation.completed"
]