Code Component

Author and run your own code

Component key: code

Description#

The code component allows you to write your own short snippets of JavaScript code, and is handy for writing quick functions or data transformations that are specific to your product or industry. Please see the full article on the code component for information on when a code component is appropriate, and common use cases for a code component.

Code component steps should be succinct and integration-specific. If the code you write could be reused in other integrations, if it needs to handle credentials, or if the code is complex enough that it would benefit from unit tests, etc., you should write a custom component instead.

For some examples of code component usage, check out these quickstart guides:

Code Connections#

API Key#

Input	Notes
Input API Key string / Required	Notes API Key

API Key Secret#

Input	Notes
Input API Key string / Required	Notes API Key
Input API Secret password / Required	Notes API Secret

OAuth 2.0 Authorization Code#

Input	Notes
Input Authorize URL string / Required	Notes The OAuth 2.0 Authorization URL for the API
Input Client ID string / Required	Notes Client Identifier of your app for the API
Input Client Secret password / Required	Notes Client Secret of your app for the API
Input Headers string Key Value List	Notes Additional header to supply to authorization requests
Input Scopes string	Notes Space separated OAuth 2.0 permission scopes for the API
Input Token URL string / Required	Notes The OAuth 2.0 Token URL for the API

Basic Username/Password#

Input	Notes
Input Password password / Required	Notes Password
Input Username string / Required	Notes Username

OAuth 2.0 Client Credentials#

Input	Notes
Input Client ID string / Required	Notes Client Identifier of your app for the API
Input Client Secret string / Required	Notes Client Secret of your app for the API
Input Headers string Key Value List	Notes Additional header to supply to token requests
Input Scopes string	Notes Space separated OAuth 2.0 permission scopes for the API
Input Token URL string / Required	Notes The OAuth 2.0 Token URL for the API

Private Key#

Input	Notes
Input Private Key text / Required	Notes Private Key
Input Username string / Required	Notes Username

Actions#

Code Block#

Author and run your own code | key: runCode

Input Default Notes

Input	Default	Notes
Input Code code / Required	Default /* Config variables can be accessed by referencing configVars["Variable Name"]: const apiEndpoint = `${configVars["App Base URL"]}/api`; Log lines can be written out using the logger object: logger.log("This code component has started"); logger.warn(`Received some unexpected data: ${stepResults.someStep.results}`); Results from the trigger and previous steps can be accessed through the stepResults object. The trigger and step names are translated to camelCaseNames. If a previous step named "Get Data From API" returned an object {"foo": "bar", "baz": 123}, for example: { foo, baz } = stepResults.getDataFromApi.results Return values of a code component follow the form: return { data: results } results can be a string ("abc"), number (123.4), complex object ({foo: "bar", baz: 123}), or binary file (like an image or PDF). For more information on the code component, see https://prismatic.io/docs/code-component-usage*/ module.exports = async ({ logger, configVars }, stepResults) => { return { data: null };};	Notes The code to be executed

Input

Code

code

/ Required

Default

/* Config variables can be accessed by referencing configVars["Variable Name"]:   const apiEndpoint = `${configVars["App Base URL"]}/api`;
 Log lines can be written out using the logger object:   logger.log("This code component has started");   logger.warn(`Received some unexpected data: ${stepResults.someStep.results}`);
 Results from the trigger and previous steps can be accessed through the stepResults object. The trigger and step names are translated to camelCaseNames. If a previous step named "Get Data From API" returned an object  {"foo": "bar", "baz": 123}, for example:   { foo, baz } = stepResults.getDataFromApi.results
 Return values of a code component follow the form:   return { data: results } results can be a string ("abc"), number (123.4), complex object ({foo: "bar", baz: 123}), or binary file (like an image or PDF).
 For more information on the code component, see https://prismatic.io/docs/code-component-usage*/
module.exports = async ({ logger, configVars }, stepResults) => {  return { data: null };};

Notes

The code to be executed

Output Example Payload#

{  "data": null}