Action

An action is what a block can do when it is executed with Typebot. A block can have multiple actions.

Here is the sendMessage action of the Telegram block:

import { createAction, option } from '@typebot.io/forge'
import { auth } from '../auth'
import { got } from 'got'

export const sendMessage = createAction({
  auth,
  name: 'Send message',
  options: option.object({
    chatId: option.string.layout({
      label: 'Chat ID',
      placeholder: '@username',
    }),
    text: option.string.layout({
      label: 'Message text',
      input: 'textarea',
    }),
  }),
  run: {
    server: async ({ credentials: { token }, options: { chatId, text } }) => {
      try {
        await got.post(`https://api.telegram.org/bot${token}/sendMessage`, {
          json: {
            chat_id: chatId,
            text,
          },
        })
      } catch (error) {
        console.log('ERROR', error.response.body)
      }
    },
  },
})

Props

name · string · required

The name of the action.

auth · Auth

If the block requires authentication, the auth object needs to be passed to the action.

baseOptions · z.ZodObject<any>

If the block has options defined (see block props), this needs to be provided here.

options · z.ZodObject<any>

The action configuration options. See Options for more information.

run

Check out the Run documentation for more information on how this can be configured depending of your scenario.

Show properties

server · ServerRunFunction

The function to execute on the server when the block is triggered. See Run for more information.

stream

Show properties

getStreamVariableId · (options) => string | undefined

A function that returns the variable ID to stream.

run · StreamRunFunction

The function to execute to stream the variable.

web

Show properties

displayEmbedBubble · (options) => string | undefined

Show properties

parseInitFunction · WebFunctionParser

See Client function for more information.

waitForEvent

Show properties

getSaveVariableId · (options) => string | undefined

A function that returns the variable ID to save as the result of the waitForEvent function.

parseFunction · WebFunctionParser

See Client function for more information.

parseFunction · WebFunctionParser

A function that parses the function to execute on the client. See Client function for more information.