API Configuration

The Final Perform API is the core engine behind any action you define in your plugin. Once users fill out the required inputs and trigger the action, this API handles the actual communication with the external app or service.

What It Does

It executes the primary business logic—such as:

• Creating new records (e.g., contacts, leads, entries)

• Updating existing records

• Fetching specific data from an API

• Deleting a resource

When Does It Run?

After the user sets up the action inside a flow and clicks “Run” or triggers the automation, the Final Perform API is called using the values from the input fields.

API Call Responsibilities

• Connect to the external service using the correct method (GET/POST/PUT/DELETE)

• Send data from user-configured input fields

• Handle authentication (OAuth, API key, etc.)

• Map the API response to viaSocket’s internal structure

Example Usage in Code

const payload = {
  name: context.inputData.name,
  email: context.inputData.email
};

const response = await axios.post('https://api.example.com/createUser', payload, { headers });

return response.data;

Security & Validation

• You can validate inputs before sending them

• Use headers securely—don’t hardcode tokens

• Consider error handling with try/catch to manage API failures

Tip

If your API requires a dynamic URL (e.g., user ID in the path), you can build it using:

const userId = context.inputData.userId;
const url = `https://api.example.com/users/${userId}`;