create_opportunity

Facts

DescriptionCreate an opportunity

SchemaConnectors.Lever.functions.CreateOpportunity

ServiceLever

Input parameters

Required input parameters

namestringRequired

Contact full name

Examples

Scott Slacksalot

perform_asstringRequired

The user ID to perform this create action on behalf of

Examples

1a23b456-ab1c-def2-g345678h123ab

Optional input parameters

emailsarrayOptional

Contact emails

headlinestringOptional

The opportunity's headline, which is typically a list of previous companies where the contact has worked or schools that the contact has attended.

originstringOptional

The way this opportunity was added to lever

Accepted values

agencyprivateinternalreferredsourceduniversity

Output parameters

Required output parameters

opportunity_idstringRequired

Opportunity ID

Optional output parameters

opportunity_urlstringOptional

Opportunity URL

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:

LEVER_API_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.Lever.functions.CreateOpportunity, {
  //...

🧙🏼 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.

Facts​

Input parameters​