create_spend_request

Facts

DescriptionCreate spend request

SchemaConnectors.Ramp.functions.CreateSpendRequest

ServiceRamp

Input parameters

Required input parameters

amount_limitnumberRequired

The total amount limit per interval

descriptionstringRequired

The description of the spend request

Examples

Closeout items earmarked for discretionary spending

display_namestringRequired

Display name

Examples

DevRel Dept Req Fy23 closeout

iconstringRequired

Template icon

Accepted values

AdvertisingIconCardIconEducationStipendIconLunchOrderingIconOnboardingIconPerDiemCardIconSaasSubscriptionIconSoftwareTrialIconTravelExpensesIconWellnessIcon

intervalstringRequired

The time interval that the amount limit is applied to

Accepted values

ANNUALDAILYMONTHLYQUARTERLYTERTIARYTOTALWEEKLYYEARLY

primary_card_enabledbooleanRequired

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

ramp_access_tokenslack#/types/credential/oauth2Required

Ramp access token. See the authentication section for details.

reimbursements_enabledbooleanRequired

allow employees to submit for reimbursements against the issued card's limit

Optional input parameters

issue_physical_card_if_neededbooleanOptional

Issue physical card if employee doesn’t have one

Output parameters

Required output parameters

spend_idstringRequired

Spend ID

spend_program_urlstringRequired

Spend program url

Authentication

End-user authentication

User workflows that include a connector function relying on end-user authentication 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 the app.

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.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 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​