View as Markdown
Homerun icon

Homerun ACTION

Add Candidate Note

Adds a note to a candidate's profile in Homerun. See the documentation.
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Homerun account once, then configure and run Add Candidate 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: "homerun-add-candidate-note",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    homerun: { authProvisionId: "apn_xxxxxxx" },
    jobApplicationId: "Job Application ID",
    note: "Note Content",
  },
})

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.

Add Candidate Note inputs
Property Type Description
jobApplicationId Job Application ID string
The ID of the job application.
Required Dynamic
note Note Content string
The content of the note to add.
Required
displayName Display Name string
Name of the note's author.
Required

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
homerun-add-candidate-note
Version
0.0.2
App
Homerun
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes