CreateWebhookSubscriptionBody

Request body for creating a WebhookSubscription.

Definition

TypeScript
interface CreateWebhookSubscriptionBody {
  workspaceId: string;
  name: string;
  url: string;
  secret?: string | undefined;
  filter?:
    | {
        version: 1;
        root: import("/home/runner/work/aeontel/aeontel/packages/shared/src/conditions/schema").ConditionNode;
      }
    | null
    | undefined;
}

Fields

FieldTypeNotes
workspaceIdstringrequired — Workspace that will own the new subscription.
namestringrequired — Subscription name
urlstringrequired — Destination URL
secretstring | undefinedoptional — Signing secret
filter{ version: 1; root: import("/home/runner/work/aeontel/aeontel/packages/shared/src/conditions/schema").ConditionNode; } | null | undefinedoptional — Optional filter condition evaluated against each event.