---
title: "WebhookSubscription"
description: "The `WebhookSubscription` entity."
section: "Reference"
group: "Types"
order: 262
---

## Definition

```ts
interface WebhookSubscription {
  id: string;
  workspaceId: string;
  name: string;
  url: string;
  filter: {
    version: 1;
    root: import("/home/runner/work/aeontel/aeontel/packages/shared/src/conditions/schema").ConditionNode;
  } | null;
  enabled: boolean;
  createdBy: string;
  runtimeUserId: string | null;
  createdAt: string;
  updatedAt: string;
}
```

## Fields

| Field           | Type                                                                                                                             | Notes                                                                                                                                                                                                                                                                               |
| --------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id`            | `string`                                                                                                                         | `readonly` `required`                                                                                                                                                                                                                                                               |
| `workspaceId`   | `string`                                                                                                                         | `required` — Workspace this outbound subscription belongs to.                                                                                                                                                                                                                       |
| `name`          | `string`                                                                                                                         | `required` — Human-readable subscription label.                                                                                                                                                                                                                                     |
| `url`           | `string`                                                                                                                         | `required` — Destination URL events are POSTed to.                                                                                                                                                                                                                                  |
| `filter`        | `{ version: 1; root: import("/home/runner/work/aeontel/aeontel/packages/shared/src/conditions/schema").ConditionNode; } \| null` | `required` — Optional condition tree evaluated against the event. When non-null, only deliveries for matching events are dispatched. Null means every event fires a delivery — narrow with a filter like { type in [...] }.                                                         |
| `enabled`       | `boolean`                                                                                                                        | `required` — When false the subscription stops delivering events.                                                                                                                                                                                                                   |
| `createdBy`     | `string`                                                                                                                         | `required` — User who created the subscription.                                                                                                                                                                                                                                     |
| `runtimeUserId` | `string \| null`                                                                                                                 | `required` — Override the workspace default service user as the actor recorded on outbound delivery events (`webhook.delivery_completed` / `_failed` / `_exhausted`). Null = inherit workspace default. Workspace-admin-only to set; target user must be a member of the workspace. |
| `createdAt`     | `string`                                                                                                                         | `readonly` `required` — ISO-8601 timestamp of creation.                                                                                                                                                                                                                             |
| `updatedAt`     | `string`                                                                                                                         | `readonly` `required` — ISO-8601 timestamp of the last update.                                                                                                                                                                                                                      |