Workflow Trigger: API

An API Workflow is a specialized automation process that operates independently of database events like inserts or updates. These workflows are “callable” logic blocks that execute when they receive a specific signal, either from within the SnapApp UI or from an external system.

Table of Contents

• How API Workflows are Triggered
• 1. Custom Buttons on Views
• 2. External API Calls
• Configuring the Workflow Trigger
• 1. Create the Workflow
• 2. Set the Object and Type
• Building and Testing Logic
• Management
• Support

How API Workflows are Triggered

API workflows are highly versatile because they can be initiated in two primary ways:

1. Custom Buttons on Views

The most common way to use an API workflow is to trigger it manually from a user interface.

• Setup: You can create a custom button for a specific View (such as a List or Detail view) and link it to an API workflow.
• User Experience: When a user clicks the button, the workflow executes immediately using that record’s data as the context if it is on on a specific record.

2. External API Calls

These workflows can act as endpoints for third-party integrations.

• Integration: An external system can send an HTTP request to your SnapApp API endpoint to trigger the automation sequence.
• Efficiency: This allows external tools to process data, generate documents, or update statuses within SnapApp remotely.

Configuring the Workflow Trigger

1. Create the Workflow

• Navigate to Automation > Workflows in the settings sidebar.
• Click the + Add New button in the top-right header of the list.
• Provide a unique Name and Description.

2. Set the Object and Type

• Object: Select the database table that this workflow will interact with (e.g., translation_versions).
• Type: Select API from the dropdown menu.

Building and Testing Logic

Once the parent workflow is saved, you can build your automation steps.

• Diagram View: Use the Diagram View to add Action Blocks (notifications, API calls) and IF Decision Diamonds to branch logic based on the trigger context.
• Monitoring Events: Every time a user clicks your custom button or an external call is made, an entry is created in the Events list within the workflow details.
• Troubleshooting: If the workflow fails to run, check these event logs to see the incoming payload and identify where the logic stopped during testing.

Management

• Active Toggle: You can enable or disable the trigger at any time from the Workflows list view.
• Wrench Icon: Use this to enter the builder and update the child actions or visual layout.
• Pencil Icon: Use this to edit the name, object, or system permissions (Run as Admin).

Support

If you have any questions or need further assistance, please reach out to our support team.