Skip to main content

create_pending_hire

Facts​

DescriptionCreate pending hire
SchemaConnectors.GreenhouseOnboarding.functions.CreatePendingHire
ServiceGreenhouse Onboarding

Input parameters​

Required input parameters

emailstringRequired

The email address of the pending hire

Examples
scott.slacksalot@trailblazer.tld
employment_statusstringRequired

The employment status to assign to this pending new hire

Examples
full-time
first_namestringRequired

The first name of the pending hire

Examples
Scott
last_namestringRequired

Last name of the pending hire

Examples
Slacksalot
work_country_codestringRequired

The country code where this pending new hire will work

Examples
USA

Output parameters​

Optional output parameters

emailstringOptional

Email

employment_statusstringOptional

Employment status

first_namestringOptional

First name

idstringOptional

Hire ID

last_namestringOptional

Last name

work_country_codestringOptional

Work country code

Authentication​

Required workspace environment variables

This connector relies on workspace environment variables for authentication.

Before adding this connector to a workflow, the following workspace environment variables need to be configured by a workspace admin:

  • GREENHOUSE_ONBOARDING_ACCESS_KEY
  • GREENHOUSE_ONBOARDING_SECRET_KEY

Admins can set workspace environment variables for connectors that require them from within Workflow Builder, in the Manage Integrations section.

To open the Manage Integrations section, open Workflow Builder and access the additional options menu to the right of the Create Workflow button.

Usage info​

First, import Connectors from deno-slack-hub into your project's import_map.json file, like this:

import_map.json
{
    "imports": {
      "deno-slack-hub/": "https://deno.land/x/deno_slack_hub@2.2.0/",
      "deno-slack-sdk/": "https://deno.land/x/deno_slack_sdk@2.14.2/",
      "deno-slack-api/": "https://deno.land/x/deno_slack_api@2.8.0/"
    }
  }

Next, import Connectors at the top of your workflow's definition file:

my_workflow_file.ts
import { Connectors } from "deno-slack-hub/mod.ts";

Finally, add the connector as a step in your workflow just like you would a Slack function.

my_workflow_file.ts
SomeWorkflow.addStep(
  Connectors.GreenhouseOnboarding.functions.CreatePendingHire, {
  //...

🧙🏼 Your admin may need to approve the connector first. If your workspace has been configured to only allow admin-approved apps, the CLI will prompt you to send an admin approval request the first time you try to use a connector that hasn't been approved by an admin yet. While waiting for admin approval, the CLI may report an error like this:

Workflow function X is referring to an unknown step output parameter Y

You can safely ignore this error; it will go away as soon as your workspace admin approves your request to use the connector.