Skip to docs navigation

Faraday integration guide

Verified

How to connect Faraday to WEXTL and use its 1 trigger and 149 actions in your workflows. About Faraday: Predictive analytics that forecasts customer behavior from your data.

  • 1 trigger
  • 62 searches
  • 87 actions
  • Instant (webhooks)
  • Auth: API key

AI-assisted documentation33 min read

This documentation is compiled from our integration source code, internal specs for Faraday, its official API documentation and anonymized requests logs we collect from our support team[2].

Open Faraday on WEXTL →
  • Faraday
  • WEXTL
  • Gigasheet
  • Metabase
  • Grafana
  • GoSquared
  • Chameleon
  • Feedly
  • Userflow
  • Databox
  • ActivTrak
  • Klipfolio
  • ProfitWell
  • Mixpanel
  • SegMetrics
  • Playvox
  • WhatConverts
  • The Official Board
  • Tableau
  • Microsoft Reports
  • Microsoft Power BI
  • Monitask
  • Ignition Reporting
  • API KeypasswordRequired

    Your API key from app.faraday.ai/settings. The REST API is available on enterprise accounts.[1]

  1. Log in to your WEXTL account, add the Faraday node module to your workflow, and click Create new credential.Instant triggers use webhooks. Click Create a webhook first when adding one, then create the credential.
  2. Optional: In the Credential name field, enter a name for the credential.
  3. Enter the authentication credentials you copied from your Faraday account, or follow the on-screen instructions to create the credential.
  4. If prompted, authenticate your account and confirm access.
  5. If you want to make changes to your credential in the future, follow the steps in Manage credentials →

Watch Events

TriggerStarts on Faraday webhook events as they arrive.
Output fields[3]
FieldType
Typetext
Timestampdate
Account IDtext
Resource Typetext
Resource IDtext

Download a Target CSV

SearchCSV export of a delivery target.
Input fields[3]
FieldType
TargetRequired
choice
Output fields[3]
FieldType
Fileobject
Filenametext
Mime Typetext

Download an Upload

SearchFetches one stored upload.
Input fields[3]
FieldType
UploadRequired
choice
Output fields[3]
FieldType
Fileobject
Filenametext
Mime Typetext

Find or Create a Stream

ActionGets a stream by name, creating it if needed.
Input fields[3]
FieldType
Stream NameRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

4other output fields

Get a Cohort

SearchOwner account and state of a cohort.
Input fields[3]
FieldType
CohortRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Min countnumber

Get a Connection

SearchState of a saved data connection.
Input fields[3]
FieldType
ConnectionRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext

Get a Dataset

SearchStatus and name of one dataset.
Input fields[3]
FieldType
DatasetRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Identity setsobject
Optionsobject
Typetext

1other output field

Get a Forecast

SearchCreation date of one forecast.
Input fields[3]
FieldType
ForecastRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Horizonobject
Max daysnumber

Get a Forecast Analysis

SearchComputed analysis output for a single forecast.
Input fields[3]
FieldType
ForecastRequired
choice
Output fields[3]
FieldType
Forecast idtext

Get a Persona Set

SearchPersona set details from your account.
Input fields[3]
FieldType
Persona SetRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Cohort idtext
Number of clustersnumber

Get a Recommender

SearchCurrent state of a recommender.
Input fields[3]
FieldType
RecommenderRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Stream property nametext

Get a Recommender Analysis

SearchComputed analysis output for one recommender.
Input fields[3]
FieldType
RecommenderRequired
choice
Output fields[3]
FieldType
Recommender idtext

Get a Scope

SearchName and status of a single scope.
Input fields[3]
FieldType
ScopeRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Populationobject
Cohort idsarray
Payloadobject
Attributesarray

1other output field

Get a Scope Analysis

SearchOverall analysis report of a scope.
Input fields[3]
FieldType
ScopeRequired
choice
Output fields[3]
FieldType
Scope idtext

Get a Stream

SearchStream record with name and state.
Input fields[3]
FieldType
StreamRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

4other output fields

Get a Stream Analysis

SearchNumber of records held by a stream.
Input fields[3]
FieldType
StreamRequired
choice
Output fields[3]
FieldType
Stream idtext
Record countnumber

Get a Target

SearchCreation time of a single target.
Input fields[3]
FieldType
TargetRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Scope idtext
Representationobject
Transform presettext

1other output field

Get a Target Analysis

SearchReport of computed analysis for a target.
Input fields[3]
FieldType
TargetRequired
choice
Output fields[3]
FieldType
Target idtext

Get a Trait

SearchName and state lookup for one trait.
Input fields[3]
FieldType
TraitRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Statistical typetext
Literateboolean

2other output fields

Get a Webhook Endpoint

SearchWebhook endpoint settings and status.
Input fields[3]
FieldType
Webhook EndpointRequired
choice
Output fields[3]
FieldType
IDtext
URLtext
Enabled eventsarray
Statustext
Created atdate

Get an Account

SearchAccount details with name and status.
Input fields[3]
FieldType
AccountRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Api keytext
Brandingobject
Logo urltext

1other output field

Get an Atlas

SearchStatus and creation time of an atlas.
Input fields[3]
FieldType
AtlasRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext
Output to locationsobject

Get an Attribute

SearchAttribute lookup with its creation date.
Input fields[3]
FieldType
AttributeRequired
text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

5other output fields

Get an Outcome

SearchCurrent state of an outcome.
Input fields[3]
FieldType
OutcomeRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Attainment cohort idtext
Prediction modetext

Get an Outcome Analysis

SearchModel performance for one outcome.
Input fields[3]
FieldType
OutcomeRequired
choice
Output fields[3]
FieldType
Outcome idtext
Performanceobject

Get Current and Sub-Account Usage

SearchCombined usage for an account and its children.
Output fields[3]
FieldType
Account idtext
Period starttext
Period endtext
Scopesnumber
Lookupsnumber

Get the Account Billing

SearchBilling plan and state for one of your accounts.
Input fields[3]
FieldType
AccountRequired
choice
Output fields[3]
FieldType
Account idtext
Plantext
Statustext

Get the Account Usage

SearchUsage totals for one account over a period.
Input fields[3]
FieldType
AccountRequired
choice
Output fields[3]
FieldType
Account idtext
Period starttext
Period endtext
Scopesnumber
Lookupsnumber

Get the Current Account

SearchThe account your key works in.
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Api keytext
Brandingobject
Logo urltext

1other output field

Get the Current Account Billing

SearchBilling plan and state for your own account.
Output fields[3]
FieldType
Account idtext
Plantext
Statustext

Get the Current Account Usage

SearchTotals consumed by the account that owns the key.
Output fields[3]
FieldType
Account idtext
Period starttext
Period endtext
Scopesnumber
Lookupsnumber

Get the Dependency Graph

SearchResource dependency map for the account.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Typetext
Upstreamarray
Downstreamarray

Get the Dimensions of a Persona Set

SearchDimensions that split a persona set apart.
Input fields[3]
FieldType
Persona SetRequired
choice
Output fields[3]
FieldType
Dimensionsarray

Get the Dimensions of a Trait

SearchAnalysis dimensions found for a trait.
Input fields[3]
FieldType
TraitRequired
choice
Output fields[3]
FieldType
Dimensionsarray

Get the Efficacy of a Scope

SearchEfficacy measurements computed for a scope.
Input fields[3]
FieldType
ScopeRequired
choice
Output fields[3]
FieldType
Scope idtext

Get the Geography of a Scope

SearchWhere the people of a scope are located.
Input fields[3]
FieldType
ScopeRequired
choice
Output fields[3]
FieldType
Scope idtext

Get the Membership of a Cohort

SearchHow many people a cohort contains.
Input fields[3]
FieldType
CohortRequired
choice
Output fields[3]
FieldType
Cohort idtext
Member countnumber

Get Usages

SearchScope usage across the account.
Output fields[3]
FieldType
Scopesarray

List Accounts

SearchAll accessible accounts, optionally narrowed by ID.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Api keytext
Brandingobject
Logo urltext

1other output field

List Atlas Locations

SearchPlaces stored by one atlas.
Input fields[3]
FieldType
AtlasRequired
choice
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Latitudenumber
Longitudenumber

List Atlases

SearchAtlases set up to output locations.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext
Output to locationsobject

List Attributes

SearchFeature store attributes with their status.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

5other output fields

List Cohorts

SearchPopulation groups with their status.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Min countnumber

List Connection Datasets

SearchDatasets fed by one outside system.
Input fields[3]
FieldType
ConnectionRequired
choice
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate

List Connection Targets

SearchTargets writing to one outside system.
Input fields[3]
FieldType
ConnectionRequired
choice
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate

List Connections

SearchSaved access points for outside data.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext

List Datasets

SearchIncoming datasets in Faraday.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Identity setsobject
Optionsobject
Typetext

1other output field

List Forecasts

SearchPredictions over stream horizons.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Horizonobject
Max daysnumber

List Insight Tables

SearchTables available for insight queries.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Nametext
Columnsarray

List Locations

SearchEvery place stored in your account.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Latitudenumber
Longitudenumber

List Outcomes

SearchModeled outcomes with their status.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Attainment cohort idtext
Prediction modetext

List Persona Sets

SearchClustered persona sets in the account.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Cohort idtext
Number of clustersnumber

List Recommenders

SearchRecommendation models in the account.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Stream property nametext

List Scope Datasets

SearchDatasets that sit behind one scope.
Input fields[3]
FieldType
ScopeRequired
choice
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate

List Scope Targets

SearchDelivery targets attached to a scope.
Input fields[3]
FieldType
ScopeRequired
choice
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate

List Scopes

SearchScope definitions in the account.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Populationobject
Cohort idsarray
Payloadobject
Attributesarray

1other output field

List Streams

SearchStreams that take in your records.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

4other output fields

List Targets

SearchDelivery targets in the account.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Scope idtext
Representationobject
Transform presettext

1other output field

List Traits

SearchTraits used to describe people.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Statistical typetext
Literateboolean

2other output fields

List Uploads

SearchFiles stored in the uploads area.
Input fields[3]
FieldType
LimitRequired
number
Output fields[3]
FieldType
Subpathtext
Sizenumber
Last modifiedtext

List Webhook Endpoints

SearchRegistered event delivery URLs.
Input fields[3]
FieldType
LimitRequired
number
IDstext
Output fields[3]
FieldType
IDtext
URLtext
Enabled eventsarray
Statustext
Created atdate

Look Up a Person on a Target

SearchChecks one individual against a target.
Input fields[3]
FieldType
TargetRequired
choice
Emailtext
Email Hashtext
Phonetext
First Nametext
Last Nametext
House Number and Streettext
Citytext

5other input fields

Output fields[3]
FieldType
Matchedboolean
Probabilitiesobject
Outcomenumber

Run an Insights Query

SearchSQL query over insight tables.
Input fields[3]
FieldType
SQLRequired
text
Output fields[3]
FieldType
Rowsarray
Rowobject

Add an Upload

ActionSaves a file into an upload directory.
Input fields[3]
FieldType
DirectoryRequired
text
File NameRequired
text
FileRequired
text
Output fields[3]
FieldType
Subpathtext
Sizenumber

Archive a Cohort

ActionArchive status change for one cohort.
Input fields[3]
FieldType
CohortRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Min countnumber

Archive a Connection

ActionConnection to external data put into the archive.
Input fields[3]
FieldType
ConnectionRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext

Archive a Dataset

ActionSends a dataset to the archive with optional dependents.
Input fields[3]
FieldType
DatasetRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Identity setsobject
Optionsobject
Typetext

1other output field

Archive a Forecast

ActionArchived forecast with its resulting status.
Input fields[3]
FieldType
ForecastRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Horizonobject
Max daysnumber

Archive a Persona Set

ActionClustered persona set sent to the archive.
Input fields[3]
FieldType
Persona SetRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Cohort idtext
Number of clustersnumber

Archive a Recommender

ActionArchives a recommender, dependents optional.
Input fields[3]
FieldType
RecommenderRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Stream property nametext

Archive a Scope

ActionScope definition sent to the archive.
Input fields[3]
FieldType
ScopeRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Populationobject
Cohort idsarray
Payloadobject
Attributesarray

1other output field

Archive a Stream

ActionStream of incoming records archived.
Input fields[3]
FieldType
StreamRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

4other output fields

Archive a Target

ActionSends a target and selected dependents to the archive.
Input fields[3]
FieldType
TargetRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Scope idtext
Representationobject
Transform presettext

1other output field

Archive a Trait

ActionTrait in your account sent to the archive.
Input fields[3]
FieldType
TraitRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Statistical typetext
Literateboolean

2other output fields

Archive an Atlas

ActionMoves an atlas to the archive, dependents optional.
Input fields[3]
FieldType
AtlasRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext
Output to locationsobject

Archive an Outcome

ActionArchives an outcome together with chosen dependents.
Input fields[3]
FieldType
OutcomeRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Attainment cohort idtext
Prediction modetext

Create a Cohort

ActionDescribes a population through conditions.
Input fields[3]
FieldType
NameRequired
text
Streamchoice
Minimum Countnumber
Maximum Countnumber
Minimum Valuenumber
Maximum Valuenumber
Recency (JSON)text
Exploreboolean

5other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Min countnumber

Create a Connection

ActionReusable source definition for data pipelines.
Input fields[3]
FieldType
NameRequired
text
Options (JSON)Required
text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext

Create a Dataset

ActionDefines an incoming dataset with identity sets.
Input fields[3]
FieldType
NameRequired
text
Identity Sets (JSON)Required
text
Options (JSON)Required
text
Connectionchoice
Privacychoice
Previewboolean
Incremental Columntext
Reference Key Columntext

6other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Identity setsobject
Optionsobject
Typetext

1other output field

Create a Forecast

ActionDefines a prediction over a stream horizon.
Input fields[3]
FieldType
NameRequired
text
StreamRequired
choice
Stream Property NameRequired
text
Entry StreamRequired
choice
Horizon (JSON)Required
text
Eligible Cohortchoice
Predictors (JSON)text
Stream Conditions (JSON)text

1other input field

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Horizonobject
Max daysnumber

Create a Persona Set

ActionSegments a cohort by chosen dimensions.
Input fields[3]
FieldType
NameRequired
text
CohortRequired
choice
Number of Clustersnumber
Exploreboolean
Previewboolean
Clustering Dimensions (JSON)text
Modeling Fieldstext
Modeling Attributestext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Cohort idtext
Number of clustersnumber

Create a Recommender

ActionRecommends from the values of one stream property.
Input fields[3]
FieldType
NameRequired
text
StreamRequired
choice
Stream Property NameRequired
text
Predictors (JSON)text
Previewboolean
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Stream property nametext

Create a Scope

ActionDefines the population and payload of a scope.
Input fields[3]
FieldType
NameRequired
text
Population (JSON)Required
text
Payload (JSON)Required
text
PreviewRequired
boolean
Insightschoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Populationobject
Cohort idsarray
Payloadobject
Attributesarray

1other output field

Create a Target

ActionDelivers a scope in a chosen representation.
Input fields[3]
FieldType
NameRequired
text
ScopeRequired
choice
Representation (JSON)Required
text
Options (JSON)Required
text
Connectionchoice
Filter (JSON)text
Limit Rows (JSON)text
Custom Structure (JSON)text

2other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Scope idtext
Representationobject
Transform presettext

1other output field

Create a Trait

ActionAdds a trait for describing people.
Input fields[3]
FieldType
NameRequired
text
Readable Nametext
Descriptiontext
Unittext
Statistical Typechoice
Lookup Table (JSON)text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Statistical typetext
Literateboolean

2other output fields

Create a Webhook Endpoint

ActionRegisters a URL for Faraday event calls.
Input fields[3]
FieldType
URLRequired
text
EventsRequired
choice
Output fields[3]
FieldType
IDtext
URLtext
Enabled eventsarray
Statustext
Created atdate
Signing Secrettext

Create an Account

ActionAdds an account, optionally with branding.
Input fields[3]
FieldType
NameRequired
text
Branding (JSON)text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Api keytext
Brandingobject
Logo urltext

1other output field

Create an Atlas

ActionAtlas that writes mapped columns to locations.
Input fields[3]
FieldType
NameRequired
text
Options (JSON)Required
text
Output to Locations (JSON)Required
text
Connectionchoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext
Output to locationsobject

Create an Attribute

ActionDefines a feature store attribute fed from a stream property.
Input fields[3]
FieldType
NameRequired
text
Readable NameRequired
text
DescriptionRequired
text
CategoryRequired
choice
TierRequired
choice
Feature StoreRequired
choice
StreamRequired
choice
Value Property NameRequired
text

5other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

5other output fields

Create an Outcome

ActionModels an outcome using an attainment cohort.
Input fields[3]
FieldType
NameRequired
text
Attainment CohortRequired
choice
Eligible Cohortchoice
Attrition Cohortchoice
Prediction Modechoice
Feature Blocklisttext
Predictors (JSON)text
Bias Mitigation (JSON)text

1other input field

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Attainment cohort idtext
Prediction modetext

Delete a Cohort

ActionRemoves a defined group of people.
Input fields[3]
FieldType
CohortRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Connection

ActionDeletes a stored link to external data.
Input fields[3]
FieldType
ConnectionRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Dataset

ActionRemoves an incoming data feed.
Input fields[3]
FieldType
DatasetRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Forecast

ActionDeletes a saved prediction setup.
Input fields[3]
FieldType
ForecastRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Persona Set

ActionDeletes one persona clustering built from a cohort.
Input fields[3]
FieldType
Persona SetRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Recommender

ActionRemoves a recommendation model.
Input fields[3]
FieldType
RecommenderRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Scope

ActionDeletes one delivery definition.
Input fields[3]
FieldType
ScopeRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Stream

ActionRemoves an ingested record stream.
Input fields[3]
FieldType
StreamRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Target

ActionDeletes a delivery configuration for a scope.
Input fields[3]
FieldType
TargetRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Trait

ActionDeletes a trait definition from your account.
Input fields[3]
FieldType
TraitRequired
choice
Output fields[3]
FieldType
Successboolean

Delete a Webhook Endpoint

ActionDeletes an event delivery endpoint.
Input fields[3]
FieldType
Webhook EndpointRequired
choice
Output fields[3]
FieldType
Successboolean

Delete an Account

ActionRemoves one account record from the platform.
Input fields[3]
FieldType
AccountRequired
choice
Output fields[3]
FieldType
Successboolean

Delete an Atlas

ActionAtlas definition removed from Faraday.
Input fields[3]
FieldType
AtlasRequired
choice
Output fields[3]
FieldType
Successboolean

Delete an Attribute

ActionSingle attribute definition removed.
Input fields[3]
FieldType
AttributeRequired
text
Output fields[3]
FieldType
Successboolean

Delete an Outcome

ActionRemoves a predicted outcome definition.
Input fields[3]
FieldType
OutcomeRequired
choice
Output fields[3]
FieldType
Successboolean

Delete an Upload

ActionRemoves one stored file from the uploads area.
Input fields[3]
FieldType
UploadRequired
choice
Output fields[3]
FieldType
Successboolean

Force Update a Cohort

ActionFresh cohort run on request.
Input fields[3]
FieldType
CohortRequired
choice
Output fields[3]
FieldType
Successboolean
Cohort idtext

Force Update a Connection

ActionReruns a connection to an outside system.
Input fields[3]
FieldType
ConnectionRequired
choice
Output fields[3]
FieldType
Successboolean
Connection idtext

Force Update a Dataset

ActionRebuilds a dataset on demand.
Input fields[3]
FieldType
DatasetRequired
choice
Output fields[3]
FieldType
Successboolean
Dataset idtext

Force Update a Forecast

ActionRuns a forecast again at your request.
Input fields[3]
FieldType
ForecastRequired
choice
Output fields[3]
FieldType
Successboolean
Forecast idtext

Force Update a Persona Set

ActionReruns a persona set whenever you ask.
Input fields[3]
FieldType
Persona SetRequired
choice
Output fields[3]
FieldType
Successboolean
Persona set idtext

Force Update a Recommender

ActionRecomputes a recommender when called.
Input fields[3]
FieldType
RecommenderRequired
choice
Output fields[3]
FieldType
Successboolean
Recommender idtext

Force Update a Scope

ActionRefreshes a scope immediately.
Input fields[3]
FieldType
ScopeRequired
choice
Output fields[3]
FieldType
Successboolean
Scope idtext

Force Update a Stream

ActionReruns a stream with no waiting.
Input fields[3]
FieldType
StreamRequired
choice
Output fields[3]
FieldType
Successboolean

Force Update a Target

ActionRefreshes a target outright.
Input fields[3]
FieldType
TargetRequired
choice
Output fields[3]
FieldType
Successboolean
Target idtext

Force Update a Trait

ActionRuns a trait one more time.
Input fields[3]
FieldType
TraitRequired
choice
Output fields[3]
FieldType
Successboolean
Trait idtext

Force Update an Atlas

ActionTriggers a rerun of an atlas.
Input fields[3]
FieldType
AtlasRequired
choice
Output fields[3]
FieldType
Successboolean
Atlas idtext

Force Update an Attribute

ActionReruns an attribute on demand.
Input fields[3]
FieldType
AttributeRequired
text
Output fields[3]
FieldType
Successboolean

Force Update an Outcome

ActionRecalculates an outcome on demand.
Input fields[3]
FieldType
OutcomeRequired
choice
Output fields[3]
FieldType
Successboolean
Outcome idtext

Make an API Call

universalFree-form Faraday REST API request.
Input fields[3]
FieldType
URLRequired
text
MethodRequired
choice
Headersarray
Headerobject
Query Stringarray
Parameterobject
Bodytext
Output fields[3]
FieldType
Bodytext
Headersobject
Content-Typetext
Status codenumber

Rotate Connection Credentials

ActionSwaps the stored secrets of an outside system link.
Input fields[3]
FieldType
ConnectionRequired
choice
Connection TypeRequired
choice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext

Start a Target Preview

ActionStarts a trial run of a target.
Input fields[3]
FieldType
TargetRequired
choice
Output fields[3]
FieldType
Successboolean
Target idtext

Unarchive a Cohort

ActionCohort brought back from the archive.
Input fields[3]
FieldType
CohortRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Min countnumber

Unarchive a Connection

ActionConnection to external data restored.
Input fields[3]
FieldType
ConnectionRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext

Unarchive a Dataset

ActionReopened dataset, dependents optional.
Input fields[3]
FieldType
DatasetRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Identity setsobject
Optionsobject
Typetext

1other output field

Unarchive a Forecast

ActionForecast taken out of the archive.
Input fields[3]
FieldType
ForecastRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Horizonobject
Max daysnumber

Unarchive a Persona Set

ActionClustered persona set out of the archive.
Input fields[3]
FieldType
Persona SetRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Cohort idtext
Number of clustersnumber

Unarchive a Recommender

ActionRecommender out of the archive.
Input fields[3]
FieldType
RecommenderRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Stream property nametext

Unarchive a Scope

ActionScope definition out of the archive.
Input fields[3]
FieldType
ScopeRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Populationobject
Cohort idsarray
Payloadobject
Attributesarray

1other output field

Unarchive a Stream

ActionStream of incoming records restored.
Input fields[3]
FieldType
StreamRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

4other output fields

Unarchive a Target

ActionReinstated target with selected dependents.
Input fields[3]
FieldType
TargetRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Scope idtext
Representationobject
Transform presettext

1other output field

Unarchive a Trait

ActionTrait in your account restored.
Input fields[3]
FieldType
TraitRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Statistical typetext
Literateboolean

2other output fields

Unarchive an Atlas

ActionAtlas back from the archive, dependents optional.
Input fields[3]
FieldType
AtlasRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext
Output to locationsobject

Unarchive an Outcome

ActionRevived outcome with chosen dependents.
Input fields[3]
FieldType
OutcomeRequired
choice
Cascade to Allboolean
Cascade Totext
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Attainment cohort idtext
Prediction modetext

Update a Cohort

ActionEdits who belongs to a cohort.
Input fields[3]
FieldType
CohortRequired
choice
Nametext
Streamchoice
Minimum Countnumber
Maximum Countnumber
Minimum Valuenumber
Maximum Valuenumber
Recency (JSON)text

7other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Min countnumber

Update a Connection

ActionEdits a link to an outside data system.
Input fields[3]
FieldType
ConnectionRequired
choice
Nametext
Options (JSON)text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext

Update a Dataset

ActionEdits how a dataset reads and keys its records.
Input fields[3]
FieldType
DatasetRequired
choice
Nametext
Identity Sets (JSON)text
Options (JSON)text
Privacychoice
Previewchoice
Incremental Columntext
Reference Key Columntext

7other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Identity setsobject
Optionsobject
Typetext

1other output field

Update a Forecast

ActionStream, horizon and currency edits.
Input fields[3]
FieldType
ForecastRequired
choice
Nametext
Streamchoice
Stream Property Nametext
Entry Streamchoice
Horizon (JSON)text
Eligible Cohortchoice
Predictors (JSON)text

3other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Horizonobject
Max daysnumber

Update a Persona

ActionRenames a single persona of a set.
Input fields[3]
FieldType
Persona SetRequired
choice
Persona IDRequired
text
NameRequired
text
Output fields[3]
FieldType
IDtext
Nametext

Update a Persona Set

ActionEdits how a persona set is clustered.
Input fields[3]
FieldType
Persona SetRequired
choice
Nametext
Number of Clustersnumber
Explorechoice
Previewchoice
Clustering Dimensions (JSON)text
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Cohort idtext
Number of clustersnumber

Update a Recommender

ActionEdits the inputs of a recommender.
Input fields[3]
FieldType
RecommenderRequired
choice
Nametext
Streamchoice
Stream Property Nametext
Predictors (JSON)text
Previewchoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Stream nametext
Stream property nametext

Update a Scope

ActionEdits the population and payload of a scope.
Input fields[3]
FieldType
ScopeRequired
choice
Nametext
Population (JSON)text
Payload (JSON)text
Previewchoice
Insightschoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Populationobject
Cohort idsarray
Payloadobject
Attributesarray

1other output field

Update a Stream

ActionEdits stream labels, tier and properties.
Input fields[3]
FieldType
StreamRequired
choice
Categorychoice
Tierchoice
Descriptiontext
Readable Nametext
Properties (JSON)text
Deprecatedchoice
Deprecation Notestext

1other input field

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

4other output fields

Update a Target

ActionEdits delivery format, filter and row limit of a target.
Input fields[3]
FieldType
TargetRequired
choice
Nametext
Representation (JSON)text
Options (JSON)text
Connectionchoice
Filter (JSON)text
Limit Rows (JSON)text
Custom Structure (JSON)text

3other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Scope idtext
Representationobject
Transform presettext

1other output field

Update a Trait

ActionEdits trait labels, unit and lookup table.
Input fields[3]
FieldType
TraitRequired
choice
Readable Nametext
Descriptiontext
Unittext
Statistical Typechoice
Lookup Table (JSON)text
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Statistical typetext
Literateboolean

2other output fields

Update a Webhook Endpoint

ActionEdits where and when events are sent.
Input fields[3]
FieldType
Webhook EndpointRequired
choice
URLtext
Eventschoice
Statuschoice
Output fields[3]
FieldType
IDtext
URLtext
Enabled eventsarray
Statustext
Created atdate

Update an Account

ActionEdits an account name or branding.
Input fields[3]
FieldType
AccountRequired
choice
Nametext
Branding (JSON)text
Clear Fieldschoice
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Api keytext
Brandingobject
Logo urltext

1other output field

Update an Atlas

ActionEdits an atlas and its location outputs.
Input fields[3]
FieldType
AtlasRequired
choice
Nametext
Options (JSON)text
Output to Locations (JSON)text
Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Optionsobject
Typetext
Output to locationsobject

Update an Attribute

ActionEdits attribute labels, tier and unit.
Input fields[3]
FieldType
AttributeRequired
text
Nametext
Readable Nametext
Descriptiontext
Categorychoice
Tierchoice
Feature Storechoice
Streamchoice

7other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Categorytext
Tiertext

5other output fields

Update an Outcome

ActionEdits the cohorts and mode of an outcome.
Input fields[3]
FieldType
OutcomeRequired
choice
Nametext
Attainment Cohortchoice
Eligible Cohortchoice
Attrition Cohortchoice
Prediction Modechoice
Feature Blocklisttext
Predictors (JSON)text

3other input fields

Output fields[3]
FieldType
IDtext
Nametext
Statustext
Account idtext
Created atdate
Updated atdate
Attainment cohort idtext
Prediction modetext

Look for Faraday templates in the WEXTL template library.

Browse templates →
  1. WEXTL® Faraday Source Code connector implementation.
  2. Our users use cases and automations.
  3. Official API Documentation for Faraday.
  4. WEXTL® visual workflow builder data.

Last updated: Nov 14, 2026 17:45

How we write our apps documentation

How we compile these docs: sources, the role of AI, and how we verify.