View as Markdown
Heartbeat icon

Heartbeat ACTION

Create Event

Create a new Event in a Heartbeat community. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Heartbeat account once, then configure and run Create Event from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "heartbeat-create-event",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    heartbeat: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    description: "Description",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create Event inputs
Property Type Description
name Name string
The name of the event
Required
description Description string
The description of the event
Optional
startTime Start Date & Time string
The start date & time of the event. Accepts datetimes in the following formats: YYYY-MM-DD hh:mm:ss e.g. 2023-11-28 10:00:00, YYYY-MM-DD hh:mm e.g. 2023-11-28 10:00, YYYY-MM-DD e.g. 2023-11-28
Required
duration Duration integer
The duration of the event in minutes
Required
location Location string
Where the event will be held. If the string 'HEARTBEAT' is provided, then the event will take place in a Heartbeat voice channel. If the string 'ZOOM' is provided, then the event will take place in a custom Zoom link (this option can only be chosen if a Zoom account has been integrated with Heartbeat). Otherwise, the provided string will be passed directly to the Custom location field
Required
invitedUsers Invited Users string[]
A list of users that should be invited to the event. If the email matches an existing Heartbeat user, the Heartbeat user will be invited. Otherwise, an event invite will be sent directly to the provided email address. If both Invited Users & Invited Groups are empty, the event will be open to everyone in the community
Optional Dynamic
invitedGroups Invited Groups string[]
A list of groups that should be invited to the event. If both Invited Users and Invited Groups are empty, the event will be open to everyone in the community
Optional Dynamic

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
heartbeat-create-event
Version
0.0.1
App
Heartbeat
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes