WebhookSubscription

The `WebhookSubscription` entity.

Definition

TypeScript
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

FieldTypeNotes
idstringreadonly required
workspaceIdstringrequired — Workspace this outbound subscription belongs to.
namestringrequired — Human-readable subscription label.
urlstringrequired — Destination URL events are POSTed to.
filter{ version: 1; root: import("/home/runner/work/aeontel/aeontel/packages/shared/src/conditions/schema").ConditionNode; } | nullrequired — 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 [...] }.
enabledbooleanrequired — When false the subscription stops delivering events.
createdBystringrequired — User who created the subscription.
runtimeUserIdstring | nullrequired — 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.
createdAtstringreadonly required — ISO-8601 timestamp of creation.
updatedAtstringreadonly required — ISO-8601 timestamp of the last update.