Create spend request

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.Ramp.functions.CreateSpendRequest`
Service:	Ramp

Input parameters

Required parameters

ramp_access_token

slack#/types/credential/oauth2

·Required

Determines whether this connector will use the credentials of the user starting the workflow or the credentials configured by an app collaborator. See the Authentication section on this page for details.

Example

{ credential_source: "END_USER" }

display_name

string

·Required

The display name of the spend request

Example

"DevRel Dept Req Fy23 closeout"

description

string

·Required

The description of the spend request

Example

"Closeout items earmarked for discretionary spending"

icon

string

·Required

The icon to use for the spend request template

Example

One of: "AdvertisingIcon", "CardIcon", "EducationStipendIcon", "LunchOrderingIcon", "OnboardingIcon", "PerDiemCardIcon", "SaasSubscriptionIcon", "SoftwareTrialIcon", "TravelExpensesIcon", "WellnessIcon"

primary_card_enabled

boolean

·Required

If true, allows spending with physical card. This will allow employees to link their physical card, if they have one, to the issued virtual card.

Example

false

reimbursements_enabled

boolean

·Required

If true, allows employee to submit for reimbursements against the issued card's limit

Example

false

amount_limit

number

·Required

The total amount limit per interval

Example

500.00

interval

string

·Required

The time interval that the amount limit is applied to

Example

One of: "ANNUAL", "DAILY", "MONTHLY", "QUARTERLY", "TERTIARY", "TOTAL", "WEEKLY", "YEARLY"

Optional parameters

issue_physical_card_if_needed

boolean

·Optional

If true, a physical card tied to this virtual card will be issued to employees who don't have one yet.

Output parameters

Required parameters

spend_id

string

·Required

spend_program_url

string

·Required

Authentication

A connector's access token property specifies how the connector handles authentication.

End-user authentication

user Workflows that include a connector function relying on end-user authentication can can only be started with a link trigger.

ramp_access_token: {
    credential_source: "END_USER"
}

End-user experience: User will be prompted to link their external account via OAuth when they first start the workflow that contains this connector.

Developer experience: Developer does not have to implement authentication in app.

Developer authentication

ramp_access_token: {
    credential_source: "DEVELOPER"
}

End-user experience: User can start a workflow containing the connector (they are not prompted to authenticate).

Developer experience: One of the app's collaborators configures external authentication via the CLI before sharing the app with users.

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.Ramp.functions.CreateSpendRequest, {
  //...

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