Keragon provides a powerful set of standardized actions to interact with external applications and manage data records efficiently. These actions allow you to search for data, create new records, update existing ones, or delete records directly from your workflows. Understanding how these action types work will help you build precise and effective automations.
Action Types and Naming Conventions
Keragon follows a consistent naming pattern for actions based on the type of operation they perform. Here's how to identify and use them:
1. Get [Single] — Retrieve a Record by ID
-
Purpose: Retrieve a single record when you already have its unique ID.
-
When to Use: When a previous step has provided you with a record ID.
-
Example:
Get Patient -
Inputs Required: Patient ID.
-
Outputs: Returns a single object if found. If not found, the action fails resulting in workflow failure.
2. Get [Plural] — Search for Records
-
Purpose: Search for one or more records based on specific criteria.
-
When to Use: When you have data (like email, name, or status) and want to find matching records.
-
Example:
Get Appointments -
Inputs Required: Search fields (e.g., date, patient name).
-
Outputs: Returns an array (list) with one or more records if found; otherwise, returns an empty list.
3. Create [Single] — Create a New Record
-
Purpose: Add a new record to the connected app.
-
When to Use: When no existing record matches and you need to create a new entry.
-
Example:
Create Appointment -
Inputs Required: Required fields for the new record.
-
Outputs: Returns the response data from the app, typically including the newly created record’s details.
4. Update [Single] — Update an Existing Record
-
Purpose: Modify an existing record.
-
When to Use: When you already have the record’s ID and want to update its fields.
-
Example:
Update Appointment -
Inputs Required: Record ID and updated fields.
-
Outputs: Returns the response data from the app, typically including the updated record’s details.
5. Create or Update [Single] — Upsert (Search, Then Create or Update)
-
Purpose: First searches for a record using defined criteria; if found, updates it. If not found, creates a new record.
-
When to Use: When you’re unsure if a record exists and want to avoid duplicates.
-
Example:
Create or Update Appointment -
Inputs Required: Search criteria and record fields.
-
Outputs: Returns the response data from the app, either the updated or newly created record details.
Alternative Approach
If the Upsert action is not available for your app, you can achieve the same result by using the Branch logic component. Learn how to use Branch to search, then create or update a record.
6. Delete [Single] — Delete a Record by ID
-
Purpose: Permanently remove a record.
-
When to Use: When you have the record’s ID and want to delete it.
-
Example:
Delete Appointment -
Inputs Required: Record ID.
-
Outputs: Returns the response data from the app indicating the result of the delete operation.
Choosing the Right Action for Your Workflow
-
Use Get [Single] when you have the exact record ID.
-
Use Get [Plural] to search for records based on field values.
-
Use Create when you’re sure the record doesn’t already exist.
-
Use Update when you have the record ID and need to modify data.
-
Use Create or Update to prevent duplicates and ensure the data exists.
-
Use Delete to remove records permanently.
By understanding these action types, you can design smarter workflows that accurately manage data across your connected applications.