Block

After using the CLI to create your new block. The index.ts file contains the block definition. It should look like:

Props

id · string · required

The block ID. It should be unique all the other blocks.

name · string · required

A concise name for the block. Should be short enough to fit into a small block card.

LightLogo · (props: React.SVGProps<SVGSVGElement>) => React.JSX.Element · required

DarkLogo · (props: React.SVGProps<SVGSVGElement>) => React.JSX.Element

Logo used on the dark mode.

fullName · string

The full name that will be displayed as a tooltip when the mouse hovers the block card.

tags · string[]

List of strings describing the block. Used for block searching.

auth · Auth

See Auth for more information.

actions · Action[]

A list of all the possible actions that this block provides. See Action for more information

docsUrl · string

The dedicated documentation URL. (i.e. https://docs.typebot.io/editor/blocks/integrations/openai)

options · z.ZodObject<any>

Provide it if all the block actions share the same properties. See Options for more information. In the block settings it will then be displayed between the auth and the actions:

fetchers · Fetcher[]

A list of fetchers used in the provided options. See Fetcher for more information.