View as Markdown
Ashby icon

Ashby ACTION

Create Candidate

Creates a new candidate in Ashby. See the documentation
  • Action
  • Writes data
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Ashby account once, then configure and run Create Candidate 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: "ashby-create-candidate",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ashby: { authProvisionId: "apn_xxxxxxx" },
    name: "Name",
    email: "Email",
  },
})

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 Candidate inputs
Property Type Description
name Name string
The first and last name of the candidate to be created.
Required
email Email string
Primary, personal email of the candidate to be created
Optional
phoneNumber Phone Number string
Primary, personal phone number of the candidate to be created
Optional
linkedInUrl LinkedIn URL string
URL to the candidate's LinkedIn profile. Must be a valid URL.
Optional
githubUrl GitHub URL string
URL to the candidate's GitHub profile. Must be a valid URL.
Optional
website Website string
URL of the candidate's website. Must be a valid URL.
Optional
alternateEmailAddresses Alternate Email Addresses string[]
Array of alternate email addresses to add to the candidate's profile
Optional
sourceId Source ID string
The source to set on the candidate being created
Optional Dynamic
creditedToUserId Credited To User ID string
The ID of the user the candidate will be credited to
Optional Dynamic
city City string
The city of the candidate's location
Optional
region Region string
The region (state, province, etc.) of the candidate's location
Optional
country Country string
The country of the candidate's location
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
ashby-create-candidate
Version
0.0.4
App
Ashby
Authentication
API key
Read-only
No
Destructive
No
Open world
Yes