Athena

Hooks

This index covers the exported React hooks that power the workspace admin surfaces.

Items

  • useAdminAthenaClients: Query hook for the list of admin-configured Athena clients available to the workspace tools.
  • useAdminAuditLogs: Convenience query hook for recent admin audit logs with a default limit of 20 rows.
  • useAdminAuditLogsQuery: Lower-level audit log query hook that accepts a partial Athena list query and normalizes the default limit.
  • useAdminEmailFailures: Convenience query hook for recent email delivery failures with a default limit of 15 rows.
  • useAdminEmailFailuresQuery: Lower-level email failure query hook that accepts a partial Athena list query and normalizes the default limit.
  • useAdminEmailTemplates: Convenience query hook for email templates with a default limit of 25 rows.
  • useAdminEmailTemplatesQuery: Lower-level email template query hook that accepts a partial Athena list query and normalizes the default limit.
  • useAdminPastEmails: Convenience query hook for recent outbound emails with a default limit of 15 rows.
  • useAdminPastEmailsQuery: Lower-level outbound email query hook that accepts a partial Athena list query and normalizes the default limit.
  • useAuthUiOptions: Public React hook for auth ui options in the workspace toolset.
  • useCreateAdminApiKey: Mutation hook that creates an admin API key through the Athena admin method surface.
  • useCreateAdminAthenaClient: Mutation hook that creates an Athena client and invalidates the Athena client list.
  • useCreateAdminEmailFailure: Mutation hook that creates a new email failure record and invalidates the failure list.
  • useDeleteAdminEmailFailure: Mutation hook that deletes an email failure record and invalidates the failure list.
  • useDeleteAdminEmailRecord: Mutation hook that deletes admin email records and invalidates the related email queries.
  • useDeleteEmailTemplate: Mutation hook that deletes an email template and invalidates the template list.
  • useFetchOAuthTokens: Mutation hook that fetches or refreshes OAuth provider token bundles from the auth client.
  • useResolvedAuthUiOptions: Public React hook for resolved auth ui options in the workspace toolset.
  • useUpdateAdminEmailFailure: Mutation hook that updates existing email failure records and invalidates the failure list.
  • useUpsertAdminEmailRecord: Mutation hook that creates or updates admin email records and invalidates the related email queries.
  • useUpsertEmailTemplate: Mutation hook that creates or updates email templates and invalidates the template list.
  • useWorkspaceRuntime: Stateful runtime hook that hydrates workspace preferences and activity from session data plus local storage.
  • useWorkspaceSession: Thin session hook with a 60 second stale window for the workspace experience.

On this page