@useparagon/core
Last updated
Last updated
Use CronStep
to start the workflow on a periodic schedule.
Inputs
Parameter | Type | Description |
---|---|---|
Outputs
The CronStep does not produce any usable output.
Use EndpointStep
to trigger this workflow via an HTTP request.
Inputs
Parameter | Type | Description |
---|---|---|
Outputs
Access the output of a Request trigger with requestTrigger.output.request
. The below fields are fields of the .request
property.
Use EventStep
to trigger this workflow with an App Event.
Inputs
To construct an App Event Trigger, first import your App Event into the Workflow:
Then, pass this import to the constructor of EventStep
:
Because App Events can be shared across different workflows and integrations, they are required to be defined in the src/events
folder of your Paragraph project.
Outputs
Access the output of an App Event trigger with appEventTrigger.output
. The output will match the schema of the App Event that this trigger uses.
Use IntegrationEnabledStep
to trigger this workflow when a user enables the integration.
Inputs
This trigger does not use any parameters.
Outputs
The IntegrationEnabledStep does not produce any usable output.
A Conditional branching step to allow for control flow in Workflows.
Inputs
Outputs
A step to pause the workflow for a fixed amount of time.
Inputs
Outputs
The DelayStep does not produce any usable output.
A step to map over a set (array) of data in parallel, for e.g. data transformation or batch uploads.
Inputs
Outputs
A JavaScript function step.
Inputs
Outputs
Access the result of an Function step with functionStep.output.result
.
A step to send a custom request to the integration's API, without needing to provide auth details.
Inputs
Outputs
Access the output of an Integration Request step with requestStep.output.response
.
A step to send an HTTP request from a workflow.
Inputs
Outputs
Access the output of a Request step with requestStep.output.response
.
A step (for use in Request-triggered workflows only) to send an HTTP response from a workflow.
Inputs
Field | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Access one instance of a Fan Out step with fanOutStep.output.instance
. This can only be used by steps that are in this Fan Out's branch (see: ).
Field | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
Field | Type | Description |
---|---|---|
Parameter | Type | Description |
---|---|---|
headers
object
An object of the HTTP headers received in the request.
Access these properties in lowercased format, e.g. requestTrigger.output.request.headers['content-type']
.
body
any
An object or string of the HTTP body received in the request.
The body
will be an object when the Content-Type is application/json
, multipart/form-data
, or application/x-www-form-urlencoded
.
Otherwise, it will be attempted to be parsed as a string or File (see below).
params
object
An object of the URL parameters received in the request.
file
FileValue | undefined
If the HTTP body refers to a file, the file contents will be available as a FileValue
object. Otherwise, this property will resolve to undefined.
if
ConditionalInput*
The condition to evaluate for determining whether or not to proceed into the "true" or "false" branch beneath this step. Learn more about defining ConditionalInputs: Conditional logic
selectedChoice
"Yes" | "No"
The branch that was chosen when this ConditionalStep was evaluated.
value
number*
How long to pause the workflow for, measured by the unit
parameter.
unit
"SECONDS"
| "MINUTES"
| "HOURS"
| "DAYS"
The unit of time to use when delaying the workflow. Defaults to "MINUTES"
.
iterator
any[]
A set of data to iterate over in the Fan Out.
instance
any
An item of the iterator
property that is being processed in this branch.
code
Function*
The function to run.
This function must have the signature
function(parameters, libraries)
and must be self-contained, meaning that it cannot reference JavaScript values outside of the function body.
To pass execution data through this step, use the parameters
object.
The list of libraries
can be found in: JavaScript Libraries
parameters
object*
Parameters from other step outputs to inject into the function.
result
any
The return result of code
after evaluation with parameters
.
Note: if code
returns a Promise
, the Function step will automatically await this Promise and return the unwrapped result.
method
"GET"
| "POST"
| "PATCH"
| "PUT"
| "DELETE"
*
The HTTP method to use for this API request.
If you select POST
, PUT
, or PATCH
methods, the body
and bodyType
parameters will be required.
url
string*
The relative path of the API request, with respect to the base URL provided by the integration. Specifying a full URL is also supported.
bodyType
"json"
| "form-data"
| "x-www-form-urlencoded"
| "xml"
| "raw"
Select the type of request body that should be sent.
Paragon will automatically encode the payload and set the correct Content-Type
headers.
body
object | string |