flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

GetCost

Estimate the cost of taking a Lyft between two points.

OnInit
./lib/actions/GetCost.js
OnStartup
-
OnClose
-

Attributes

-

GetDrivers

The drivers endpoint returns a list of nearby drivers' lat and lng at a given location.

OnInit
./lib/actions/GetDrivers.js
OnStartup
-
OnClose
-

Attributes

-

GetETA

The ETA endpoint lets you know how quickly a Lyft driver can come get you

OnInit
./lib/actions/GetETA.js
OnStartup
-
OnClose
-

Attributes

-

GetProfile

The v1 of this endpoint returns the user's ID, v2 will return more general info about the user. We require authentication for this endpoint, so we extract the user ID from the access token.

OnInit
./lib/actions/GetProfile.js
OnStartup
-
OnClose
-

Attributes

-

GetRides

Get a list of past & current rides for this passenger.

OnInit
./lib/actions/GetRides.js
OnStartup
-
OnClose
-

Attributes

-

NewRide

Request a Lyft come pick you up at the given location.

OnInit
./lib/actions/NewRide.js
OnStartup
-
OnClose
-

Attributes

-

GetRide

Get the status of a ride along with information about the driver, vehicle and price of a given ride ID

OnInit
./lib/actions/GetRide.js
OnStartup
-
OnClose
-

Attributes

-

CancelRide

Cancel a ongoing ride which was requested earlier by providing the ride id.

OnInit
./lib/actions/CancelRide.js
OnStartup
-
OnClose
-

Attributes

-

SetRideDestination

Add or update the ride's destination. Note that the ride must still be active (not droppedOff or canceled), and that destinations on Lyft Line rides can not be changed.

OnInit
./lib/actions/SetRideDestination.js
OnStartup
-
OnClose
-

Attributes

-

SetRideRating

Add the passenger's 1 to 5 star rating of the ride, optional written feedback, and optional tip amount in minor units and currency. The ride must already be dropped off, and ratings must be given within 24 hours of drop off. For purposes of display, 5 is considered the default rating. When this endpoint is successfully called, payment processing will begin.

OnInit
./lib/actions/SetRideRating.js
OnStartup
-
OnClose
-

Attributes

-

GetRideReceipt

Get the receipt information of a processed ride by providing the ride id. Receipts will only be available to view once the payment has been processed. In the case of canceled ride, cancellation penalty is included if applicable.

OnInit
./lib/actions/GetRideReceipt.js
OnStartup
-
OnClose
-

Attributes

-

GetRideTypes

The ride types endpoint returns information about what kinds of Lyft rides you can request at a given location.

OnInit
./lib/actions/GetRideTypes.js
OnStartup
-
OnClose
-

Attributes

-

SetPrimeTime

Preset a Prime Time percentage in the region surrounding the specified location. This Prime Time percentage will be applied when requesting cost, or when requesting a ride in sandbox mode.

OnInit
./lib/actions/SetPrimeTime.js
OnStartup
-
OnClose
-

Attributes

-

SetRideStatus

Propagate a sandbox-ride through various ride status

OnInit
./lib/actions/SetRideStatus.js
OnStartup
-
OnClose
-

Attributes

-

SetRideTypes

The sandbox-ridetypes endpoint allows you to preset the ridetypes in the region surrounding the specified latitude and longitude to allow testing different scenarios

OnInit
./lib/actions/SetRideTypes.js
OnStartup
-
OnClose
-

Attributes

-

SetRideTypeAvailability

Set driver availability for the provided ride_type in the city/region surrounding the specified location

OnInit
./lib/actions/SetRideTypeAvailability.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-