Class ExternalEventSubscriptionsAccessor

find

• find(
      query?: FindExternalEventSubscriptionsQuery,
  ): Promise<
      PaginationResponse<
          {
              user?: {
                  id: string;
                  name: string;
                  meta?: Record<string, any>;
                  internalId: string;
                  fields?: Record<string, any>;
                  credentials?: any;
                  lastActiveAt?: string;
                  isTest?: boolean;
                  isBillable?: boolean;
                  isActive?: boolean;
                  aiCreditsRolling30DayLimit?: number | null;
                  createdAt?: string;
                  archivedAt?: string;
              };
              connection?: {
                  type?: "connector"
                  | "mcp";
                  name: string;
                  key?: string;
                  isTest?: boolean;
                  connected?: boolean;
                  disconnected?: boolean;
                  isDefunct?: boolean;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  requestError?: ErrorDataSchema;
                  error?: ErrorDataSchema;
                  integrationId?: string;
                  connectorId?: string;
                  externalAppId?: string;
                  connectorVersion?: string;
                  authOptionKey?: string;
                  createdAt: string;
                  updatedAt: string;
                  lastActiveAt?: string;
                  nextCredentialsRefreshAt?: string;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  canTest?: boolean;
                  canRefreshCredentials?: boolean;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  buildingAgentSessionId?: string;
                  clientAction?: {
                      type: "connect" | "provide-input";
                      description: string;
                      uiUrl?: string;
                      agentInstructions?: string;
                      handoffAgentInstructions?: string;
                      reason?: "provide-input" | "authenticate" | "reauthenticate";
                  };
                  id: string;
                  userId: string;
                  tenantId?: string;
              };
              integration?: {
                  logoUri: string;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  externalAppId?: string;
                  appUuid?: string;
                  isDeactivated?: boolean;
                  authType?: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  optionsConfig?: Record<
                      string,
                      { disabled?: boolean; parameters?: Record<string, any> },
                  >;
                  id: string;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  isReadOnly?: boolean;
              };
              id: string;
              name?: string;
              connectionId: string;
              integrationId: string;
              externalEventTypeId?: string;
              config?: {
                  type: ExternalEventSubscriptionType;
                  dataSource?: {
                      key?: any;
                      collectionKey?: any;
                      collectionParameters?: any;
                      udm?: any;
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      path?: any;
                      defaultPath?: any;
                  };
                  eventKey?: string;
                  eventParameters?: any;
              };
              status?: Subscribed
              | Unsubscribed
              | Error;
              error?: ErrorDataSchema;
              isRealTime?: boolean;
              requiresPull?: boolean;
              requiresFullSync?: boolean;
              createdAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
              stateData?: any;
              nextPullEventsTimestamp?: number;
              pullUpdatesIntervalSeconds?: number;
              fullSyncIntervalSeconds?: number;
              nextRefreshTimestamp?: number;
              globalWebhookKey?: string;
              globalWebhookEventSelector?: string;
              incomingWebhookUri?: string;
              webhookUri?: string;
              userId: string;
              tenantId?: string;
          },
      >,
  >

  Parameters

  • Optionalquery: FindExternalEventSubscriptionsQuery

  Returns Promise<
      PaginationResponse<
          {
              user?: {
                  id: string;
                  name: string;
                  meta?: Record<string, any>;
                  internalId: string;
                  fields?: Record<string, any>;
                  credentials?: any;
                  lastActiveAt?: string;
                  isTest?: boolean;
                  isBillable?: boolean;
                  isActive?: boolean;
                  aiCreditsRolling30DayLimit?: number | null;
                  createdAt?: string;
                  archivedAt?: string;
              };
              connection?: {
                  type?: "connector"
                  | "mcp";
                  name: string;
                  key?: string;
                  isTest?: boolean;
                  connected?: boolean;
                  disconnected?: boolean;
                  isDefunct?: boolean;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  requestError?: ErrorDataSchema;
                  error?: ErrorDataSchema;
                  integrationId?: string;
                  connectorId?: string;
                  externalAppId?: string;
                  connectorVersion?: string;
                  authOptionKey?: string;
                  createdAt: string;
                  updatedAt: string;
                  lastActiveAt?: string;
                  nextCredentialsRefreshAt?: string;
                  nextRetryTimestamp?: string;
                  retryAttempts?: number;
                  canTest?: boolean;
                  canRefreshCredentials?: boolean;
                  archivedAt?: string;
                  isDeactivated?: boolean;
                  meta?: Record<string, any>;
                  buildingAgentSessionId?: string;
                  clientAction?: {
                      type: "connect" | "provide-input";
                      description: string;
                      uiUrl?: string;
                      agentInstructions?: string;
                      handoffAgentInstructions?: string;
                      reason?: "provide-input" | "authenticate" | "reauthenticate";
                  };
                  id: string;
                  userId: string;
                  tenantId?: string;
              };
              integration?: {
                  logoUri: string;
                  connectorId?: string;
                  connectorVersion?: string;
                  oAuthCallbackUri?: string;
                  parameters?: any;
                  archivedAt?: string;
                  hasMissingParameters?: boolean;
                  hasDocumentation?: boolean;
                  hasOperations?: boolean;
                  operationsCount?: number;
                  hasData?: boolean;
                  dataCollectionsCount?: number;
                  hasEvents?: boolean;
                  eventsCount?: number;
                  hasGlobalWebhooks?: boolean;
                  hasUdm?: boolean;
                  isTest?: boolean;
                  externalAppId?: string;
                  appUuid?: string;
                  isDeactivated?: boolean;
                  authType?: | "proxy"
                  | "integration-app-token"
                  | "membrane-token"
                  | "oauth2"
                  | "oauth1"
                  | "client-credentials";
                  optionsConfig?: Record<
                      string,
                      { disabled?: boolean; parameters?: Record<string, any> },
                  >;
                  id: string;
                  uuid?: string;
                  key?: string;
                  description?: string;
                  meta?: Record<string, any>;
                  name: string;
                  state?:
                      | BUILDING
                      | CLIENT_ACTION_REQUIRED
                      | CONFIGURATION_ERROR
                      | SETUP_FAILED
                      | READY
                      | DISCONNECTING;
                  errors?: ErrorDataSchema[];
                  revision?: string;
                  createdAt?: string;
                  updatedAt?: string;
                  isReadOnly?: boolean;
              };
              id: string;
              name?: string;
              connectionId: string;
              integrationId: string;
              externalEventTypeId?: string;
              config?: {
                  type: ExternalEventSubscriptionType;
                  dataSource?: {
                      key?: any;
                      collectionKey?: any;
                      collectionParameters?: any;
                      udm?: any;
                      pullUpdatesIntervalSeconds?: number;
                      fullSyncIntervalSeconds?: number;
                      path?: any;
                      defaultPath?: any;
                  };
                  eventKey?: string;
                  eventParameters?: any;
              };
              status?: Subscribed
              | Unsubscribed
              | Error;
              error?: ErrorDataSchema;
              isRealTime?: boolean;
              requiresPull?: boolean;
              requiresFullSync?: boolean;
              createdAt?: string;
              archivedAt?: string;
              isDeactivated?: boolean;
              stateData?: any;
              nextPullEventsTimestamp?: number;
              pullUpdatesIntervalSeconds?: number;
              fullSyncIntervalSeconds?: number;
              nextRefreshTimestamp?: number;
              globalWebhookKey?: string;
              globalWebhookEventSelector?: string;
              incomingWebhookUri?: string;
              webhookUri?: string;
              userId: string;
              tenantId?: string;
          },
      >,
  >