Action types
The following is a list of the API names for Action Types, along with a list of parameters, and their validation requirements.
Text¶
auto_json – Extract JSON¶
Given the source {"value": "example"}, jsonpath set to a blank string or $, and the variable_name 'output', the following variable will be generated: $output.0.value$ which will equal 'example'. There will always be an index in the variable name!
source: stringjsonpath: stringvariable_name: stringrepeat: boolean
extract_regex – Extract Regex¶
regex: required, stringvariable_name: required, stringsource: stringdefault: stringrepeat: boolean
extract_xpath – Extract XPath¶
xpath: required, stringvariable_name: stringsource: stringdefault: string
text_decrypt – Decrypt Text¶
source: required, stringpassword: required, stringvariable_name: string
text_encrypt – Encrypt Text¶
source: required, stringpassword: required, stringvariable_name: string
text_map – Map/Translate Text¶
Acts as a translator, e.g. if X is Y then set variable to A, a comparison on a string. variable_name is the result variable. If there is no match, the default value is set to the variable_name variable.
source: stringoperator: required, string, in:eq,neq,sw,ew,ct,nct,gt,gte,lt,ltevariable_name: stringdefault: required, stringmappings: required, arraymappings.*.from: required_with:mappings, stringmappings.*.to: required_with:mappings, string
text_replace – Replace Text¶
source: required, stringvariable_name: required, stringreplacements: required, array
text_split – Split Text¶
delimiter: min:1, stringsource: required, stringvariable_name: stringrepeat: boolean
validate_json – Validate JSON¶
source: stringschema: stringvariable_name: string
Network¶
database – Database Query¶
variable_name: string, default:dbrepeat: boolean, default:falsetype: required, in:mysql,pgsql,sqlsrv,whdbdb_id: required_if:type,whdb, stringhost: required_unless:type,whdb, stringport: integer, min:1, max:65535database: required_unless:type,whdb, stringpassword: required_unless:type,whdb, stringusername: required_unless:type,whdb, stringstatement: required, stringparams: arraycharset: string
ftp_download – FTP(S) Download¶
host: required, stringport: int, min:1, max:65535password: required, stringusername: required, stringpath: required, stringssl: boolpassive: boolvariable_name: string
ftp_upload – FTP(S) Upload¶
host: required, stringport: int, min:1, max:65535password: required, stringusername: required, stringpath: required, stringcontent: required, stringssl: boolpassive: bool
http – HTTP Request¶
Sends a HTTP request and generates variables $http.content$, $http.status$, $http.header.[header_name]$, $http.error$
url: required, stringcontent: nullable, stringmethod: nullable, in:POST,GET,OPTIONS,PUT,DELETE,PATCH,TRACEmode: nullable, in:text,json,multipart,urlencoded,forwardauth: nullable, arrayauth.mode: nullable, string, in:basic,digest,ntlm,bearerauth.username: stringauth.password: stringmultipart: array, required_if:mode,multipartmultipart.*.name: stringmultipart.*.filename: stringmultipart.*.content-type: stringmultipart.*.content: stringurlencoded: arrayurlencoded.*.name: string, required_if:mode,urlencodedurlencoded.*.value: string, required_if:mode,urlencodedheaders: nullable, stringskip_ssl_verification: nullable, boolvariable_name: stringtimeout: nullable, numeric, max:60retry: arrayretry.enabled: nullable, boolretry.retries: nullable, numeric, min:1, max:10retry.delay: nullable, numeric, min:0, max:10retry.require_status: nullable, string
send_email – Send Email¶
sender: stringrecipient: required, stringcontent: stringis_html: booleansubject: required, stringattachments: array
send_email_smtp – Send Email (SMTP)¶
sender_name: stringsender_email: stringrecipient: required, stringcontent: stringis_html: booleansubject: required, stringencryption: string, in:none,ssl,tlsport: intusername: string, requiredpassword: string, requiredhost: string, requiredattachments: array
sftp_download – SFTP Download¶
provider_id: stringhost: required, stringport: int, min:1, max:65535username: required, stringpassword: stringpath: required, stringvariable_name: string
sftp_upload – SFTP Upload¶
provider_id: stringhost: required, stringport: int, min:1, max:65535username: required, stringpassword: stringpath: required, stringcontent: required, string
ssh_run_command – Run SSH Command¶
provider_id: stringhost: required, stringport: int, min:1, max:65535username: required, stringpassword: stringcommand: required, stringvariable_name: string
Behavior¶
auth_basic – Basic Auth¶
username: stringpassword: required, string
dont_save – Don't Save¶
No parameters for dont_save.
log – Log¶
Adds a log message for the user to see. If mode is markdown, it is presented as markdown for the user
text: required, stringmode: nullable, string, in:text,markdownerror: boolean
modify_response – Modify Response¶
Sets the response content of the Webhook.site URL
content: stringstatus: stringheaders: stringstop: bool
rate_limit – Rate Limit¶
period: required, intcount: required, intkey: string
sleep – Sleep¶
delay: required
stop – Stop¶
No parameters for stop.
template – Include Template¶
template_id: required, intvariables: array
Mock¶
mock – Mock OpenAPI/Swagger¶
source: required, stringpath: stringmethod: stringstatus: stringcontent_type: string
Logic¶
conditions – Conditions¶
conditions: required, arraymode: required, string, in:one,all,noneaction: required, string, in:stop,continue,noop
set_variable – Set Variable¶
name: stringvalue: nullable, stringmode: nullable, in:text,random,date,mathrandom: arrayrandom.length: int, max:10000, required_if:mode,randomrandom.characters: array, in:lowercase,uppercase,digits,symbols,userrandom.alphabet: stringrandom_number: arrayrandom_number.from: intrandom_number.to: intdate: arraydate.input: stringdate.timezone: stringdate.format: string, in:iso8601,mysql,unix,unixmicro,userdate.user_format: string
store_global_variable – Store Global Variable¶
name: required, stringvalue: nullable, string
Scripting¶
javascript – JavaScript¶
Runs JavaScript script in Node.js sandbox. Can interact with Variables using e.g. get('request.content') or set('varname', value). Global Variables retrieved using global('varname') and store('varname', value). The following libraries can be included via require(): axios, lodash, dayjs, cheerio, jsonpath, crypto, faker, nats, supabase, moment, form-data, fetch
script: required, string
script – WebhookScript¶
script: required, string
Multimedia¶
image_resize – Resize Image¶
source: string, requiredwidth: string, required_without:heightheight: string, required_without:widthaspect_ratio: bool, requiredvariable_name: string
pdf_generate – Generate PDF¶
content: stringmode: string, in:html,markdownpaper: string, in:a4,letterorientation: string, in:portrait,landscapevariable_name: string
Webhook.site¶
webhook_get_requests – Get Requests¶
variable_name: string, default:reqrepeat: booleantoken_id: required, stringsorting: stringquery: stringmax: int, default:100
Google Sheets¶
google_sheets_add_row – Add Row¶
provider_id: string, requiredspreadsheet_id: string, requiredrange: string, requiredvalues: string, requiredformula_mode: bool
google_sheets_get_values – Get Values¶
provider_id: string, requiredspreadsheet_id: string, requiredrange: string, requiredvariable_name: required, string
google_sheets_update_row – Update Row¶
provider_id: string, requiredspreadsheet_id: string, requiredrange: string, requiredvalues: string, requiredformula_mode: bool
Microsoft Excel¶
microsoft_excel_add_rows – Add Rows¶
provider_id: required, stringpath: stringtable: stringindex: intvalues: required, array
microsoft_excel_get_values – Get Values¶
provider_id: required, stringpath: required, stringworksheet: required, stringrange: required, stringvariable_name: required, string
Microsoft OneDrive¶
microsoft_drive_download – Download File¶
provider_id: required, stringpath: required, stringvariable_name: required, string
microsoft_drive_upload – Upload File¶
provider_id: required, stringpath: required, stringcontent_type: stringcontent: stringvariable_name: string
AWS S3 & Compatible¶
aws_s3_create_bucket – Create Bucket¶
provider_id: string, requiredregion: string, requiredbucket_name: string, requiredcanned_acl: string, in:private,public-read,public-read-write,authenticated-read
aws_s3_delete_object – Delete Object¶
provider_id: string, requiredregion: stringbucket_name: string, requiredobject_key: string, required
aws_s3_get_object – Get Object¶
provider_id: string, requiredregion: stringbucket_name: string, requiredobject_key: string, requiredvariable_name: string, required, min:1
aws_s3_put_object – Create Object¶
provider_id: string, requiredregion: stringbucket_name: stringobject_key: string, requiredbody: string, requiredcanned_acl: string, in:private,public-read,public-read-write,authenticated-read
AWS CloudFront¶
aws_cf_invalidate – Create Invalidation¶
provider_id: required, intdistribution_id: required, stringpaths: required, string
Discord¶
discord_send_message – Send Message¶
provider_id: required, stringcontent: required, stringusername: stringavatar_url: urlembed_type: string, in:link,image,videoembed_url: url
Slack¶
slack_send_message – Send Message¶
webhook_url: required, urlraw: boolcontent: required, string
Dropbox¶
dropbox_create_folder – Create Folder¶
provider_id: string, requiredpath: string, required
dropbox_delete – Delete¶
provider_id: string, requiredpath: string, required
dropbox_download_file – Download¶
provider_id: string, requiredpath: string, requiredvariable_name: string, required
dropbox_get_link – Get Link¶
provider_id: string, requiredpath: string, requiredvariable_name: stringtype: string, in:share_link,temporaryshare_audience: string, in:public,team,no_one
dropbox_upload_file – Upload¶
provider_id: string, requiredpath: string, requiredbody: string, requiredmode: string, required, in:add,overwrite,update
HubSpot¶
hubspot_create_contact – Create Contact¶
provider_id: required, stringproperties: required, array
X/Twitter¶
twitter_tweet – Post Tweet¶
provider_id: required, stringtweet: required, string
Pushed¶
pushed_send – Send Push Notification¶
app_key: string, requiredapp_secret: string, requiredtarget_type: string, requiredtarget: string, requiredmessage: string, required
ntfy.sh¶
ntfy – Send Push Notification¶
topic: string, requiredtitle: stringicon: stringlink: stringmessage: string, required
RabbitMQ¶
rabbitmq_get – Get Message¶
host: string, requiredport: intusername: string, requiredpassword: string, requiredvhost: stringqueue: string, requiredssl: booleanvariable_name: string
rabbitmq_publish – Publish Message¶
host: string, requiredport: intusername: string, requiredpassword: string, requiredvhost: stringqueue: string, requiredssl: booleanmessage: string, requiredproperties: array