Triggers and subscriptions API

list(options?: GetTriggersOptions): Promise<readonly TriggerDefinition[]>

create(options: CreateSubscriptionOptions): Promise<CreatedTriggerSubscription>

import { Eyeball } from "@eyeball/sdk";

const eyeball = new Eyeball({
  apiKey: process.env.EYEBALL_API_KEY!,
  baseUrl: process.env.EYEBALL_EXECUTOR_URL!,
});

const subscription = await eyeball.subscriptions.create({
  trigger: "slack.message_received",
  userId: "user_42",
  connectionId: "conn_slack",
  webhookEndpointIds: ["whe_events"],
});

delete(value: string): Promise<void>

get(value: string): Promise<TriggerSubscription>

list(options?: ListSubscriptionsOptions): Promise<TriggerSubscriptionPage>

rotateSecret(value: string): Promise<RotatedTriggerIngestSecret>

export interface GetTriggersOptions {
  toolkits?: readonly string[];
  capability?: CapabilitySlug;
  deliveryMode?: TriggerDefinition["annotations"]["deliveryMode"];
}

export interface CreateSubscriptionOptions {
  trigger: string;
  /** Uses the client-level userId when omitted. */
  userId?: string;
  connectionId?: ConnectionId;
  webhookEndpointIds: readonly string[];
  filters?: Readonly<Record<string, JsonValue>>;
  /** Polling triggers only; the catalog default is used when omitted. */
  pollIntervalSeconds?: number;
}

export interface ListSubscriptionsOptions {
  /** Uses the client-level userId when omitted; omit both to list the project. */
  userId?: string;
  cursor?: string;
  limit?: number;
}

export interface CreatedTriggerSubscription extends TriggerSubscription {
  ingestUrl?: string;
}

export type QualifiedTriggerName = `${string}.${string}`;

export interface TriggerDefinition {
  /** Exactly `<toolkit>.<canonical-trigger>`. */
  name: QualifiedTriggerName;
  toolkit: ToolkitSlug;
  capability: CapabilitySlug;
  description: string;
  payloadSchema: ObjectSchema202012;
  annotations: TriggerAnnotations;
  version: SemVer;
}

export interface TriggerEventData {
  subscriptionId: TriggerSubscriptionId;
  trigger: QualifiedTriggerName;
  userId: string;
  connectionId?: ConnectionId;
  providerEventId: string;
  occurredAt: string;
  payload: Readonly<Record<string, JsonValue>>;
}

export interface TriggerSubscription {
  subscriptionId: TriggerSubscriptionId;
  projectId: string;
  userId: string;
  trigger: QualifiedTriggerName;
  connectionId?: ConnectionId;
  webhookEndpointIds: readonly string[];
  filters?: Readonly<Record<string, JsonValue>>;
  /** Polling triggers only; omitted for push subscriptions. */
  pollIntervalSeconds?: number;
  status: TriggerSubscriptionStatus;
  createdAt: string;
  updatedAt: string;
}

export type TriggerSubscriptionId = `trgsub_${string}`;

export interface TriggerSubscriptionPage {
  subscriptions: readonly TriggerSubscription[];
  nextCursor?: string;
}

export interface TriggerWebhookEvent {
  id: string;
  type: TriggerWebhookEventType;
  createdAt: string;
  projectId: string;
  data: TriggerEventData;
}