View as Markdown
Vitally icon

Vitally ACTION

Create Note

Create a new note. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Vitally account once, then configure and run Create Note 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: "vitally-create-note",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    vitally: { authProvisionId: "apn_xxxxxxx" },
    accountId: "Account Id",
    organizationId: "Organization Id",
  },
})

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 Note inputs
Property Type Description
accountId Account Id string
The ID of the Vitally Account to associate the Note with. Not to be confused with an External ID, this is the Vitally Account ID.
Required Dynamic
organizationId Organization Id string
The Vitally assigned ID of the Organization.
Required Dynamic
note Note string
The body of the note, may include HTML.
Required
noteDate Note Date string
The timestamp of when the Note was created. Format: YYYY-MM-DDTHH:MM:mm:ss.SSSZ.
Required
externalId External Id string
The unique ID of the Note in your system.
Optional
subject Subject string
The subject or title of the Note.
Optional
authorId Assigned To Id string
The ID of the Vitally User who created the Note.
Optional Dynamic
categoryId Category Id string
The ID of the Vitally Note Category the Note belongs to.
Optional Dynamic
tags Tags string[]
An array of string tags to associate to the note.
Optional
traits Traits object
A key-value JSON object of custom note traits.
Optional

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
vitally-create-note
Version
0.0.3
App
Vitally
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes