Skip to main content
Version: 7.1.0

Create a new Action

The logic you create is executed when the action is called.

Name​

Name your action. The name can be in English and any other language of your choice.

Action ID​

Action ID is auto-generated based on the connector name in English. Action ID is used to reference your connector in when making the API call.

For example, below is an example API for executing an action.

http://{{server}}:{{port}}/v1/connector/{connectorID}/action/{actionID}/execute?userId={userID}
danger

Action ID can not be changed after the connector is published. That is to ensure the reliability of your connector once others start using your connector.

Logic​

Logic is where you define what you want the action to do. Use the logic builder to create the step-by-step workflow for your action.

Refer to How to create a Logic

Schema​

Schema is used to define the INPUT, OUTPUT, and type data in JSON Schema. For example, when you define INPUT schema, it can be used in the logic as one of the arguments.

Variables (INPUT)​

Define the INPUT schema for the data you want to received.

In the example below, an input is defined to be string value with the title group. The input value is required.

[
	{
		"title": "group",
		"type": "string",
		"x-required": true
	}
]

API Call​

The input will show up in the user’s API code snippet as below. Note that the input value group that was defined above is one of the data input needed for the API.

curl --request POST \ 
--url https://console.interactor.com/api/v1/connector/{connectorID}/{actionID}/action/getdata/execute? \
--header 'Content-Type: application/json' \
--header 'x-api-key: {API\_KEY}' \
--data '{
	"group": "{GROUP}"
}'

Data referencing​

The variable can be referenced in the Logic JS action by using below.

${input.data.group}

Output​

Similar to above variables, you can define the schema for the output values. If left empty, logic will allow any type of output.

Type​

In cases where you need to define a data schema for reuse, type can be used to define it once and reuse in other locations