API Reference JavaScript SDK EventssendEvent

sendEvent

The events method to send data through BaseHub. Flexible, type-safe and scoped by block.

import { sendEvent } from 'basehub/events'

Parameters

Key	Type	Description
`ingestKey`	`EventBlock['ingestKey']`	Required. The event unique key for ingest actions. It defines which schema is used in the second parameter (or none at all if the schema is empty)
`data`	`Record<string, unknown>`	Dynamically typed based on the `ingestKey` provided. Accepts every field in the schema defined on your Event Block.

Example

We create an Event block called "Feedback Events" with a checkbox field

'use client'
// you'll need to run basehub before importing this type 👇🏼
import type { FeedbackEvents['ingestKey'] } from '~/.basehub/schema' 
import { sendEvent } from 'basehub/events'
import { Card, IconButton } from '@radix-ui/themes'
import { ThumbsDown, ThumbsUp } from 'lucide-react'
import * as React from 'react'

export const Feedback = ({
  ingestKey,
}: {
  ingestKey: FeedbackEvents['ingestKey']
}) => {
  const [sentFeedback, setSentFeedback] = React.useState<
    'positive' | 'negative' | null
  >(null)

  const handleFeedback = (type: 'positive' | 'negative') => {
    if (sentFeedback === type) return
    sendEvent(ingestKey, { positive: type === 'positive' }) 

    setSentFeedback(type)
  }

  return (
    <Card variant="classic" size="3">
      <IconButton onClick={() => handleFeedback('negative')}>
        <ThumbsDown fill={sentFeedback === 'negative' ? 'var(--accent-12)' : 'none'} />
      </IconButton>
      <IconButton onClick={() => handleFeedback('positive')}>
        <ThumbsUp fill={sentFeedback === 'positive' ? 'var(--accent-12)' : 'none'} />
      </IconButton>
    </Card>
  )
}

Events received will look like this