Create an opportunity

Connector functions are a new addition to Slack automations. We recommend understanding the systems and APIs you're integrating with before setup.

Facts

Schema:	`Connectors.Lever.functions.CreateOpportunity`
Service:	Lever

Workspace setup

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.

Input parameters

Required parameters

perform_as

string

·Required

The user ID to perform this create action on behalf of

Example

"1a23b456-ab1c-def2-g345678h123ab"

name

string

·Required

The full name of the opportunity

Example

"Scott Slacksalot"

Optional parameters

headline

string

·Optional

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

emails

array

·Optional

An array of email addresses to associate with this opportunity

origin

string

·Optional

The way this opportunity was added to lever

Output parameters

Required parameters

opportunity_id

string

·Required

New opportunity ID

opportunity_url

string

·Required

New opportunity url

Authentication

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.

How to use

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

{
  "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 built-in Slack function.

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... is referring to an unknown step output parameter...

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