---
title: WebhookSubscriptionCreateRequest schema
description: Fields of the WebhookSubscriptionCreateRequest object in the Cascades API.
canonical_url: "https://cascades.crscreditapi.com/docs/api/schemas/WebhookSubscriptionCreateRequest"
doc_version: "1.0.0"
last_updated: "2026-10-09T18:04:24Z"
source: "public/api-docs/v1/swagger.yaml#/components/schemas/WebhookSubscriptionCreateRequest"
---

# WebhookSubscriptionCreateRequest

Defined in [openapi.json](https://cascades.crscreditapi.com/openapi.json#/components/schemas/WebhookSubscriptionCreateRequest) ([YAML](https://cascades.crscreditapi.com/openapi.yaml)).

| Field | Type | Required | Description |
|---|---|---|---|
| `url` | string (uri) | yes | HTTPS endpoint. Must resolve to a public address (no private, loopback or cloud-metadata ranges). |
| `event_filter` | array of WebhookEventName | no | Events to receive. Omit or pass `[]` for all events; unknown names return `422`. |
| `active` | boolean | no |  |

```json
{
  "url": "https://example.com",
  "event_filter": [
    "execution.completed"
  ],
  "active": true
}
```

## Sitemap

See the full [sitemap](https://cascades.crscreditapi.com/sitemap.md) for all pages.