How to Synchronize Data from Custom Tables

Introduction

This guide will show you how to synchronize or integrate Custom table data with other systems using the API and webhooks provided by the Asset & Configuration Management plugin. These features allow for automation, data syncing, and external system integration.

Target Audience

Administrator

Prerequisites

Before starting, ensure you have:

• Access to Easy WebHooks or API keys.
• Asset & Configuration Management plugin active.
• Access to the Easy Swagger documentation at /easy_swagger.

How to Synchronize Data Using API

Step 1: Open API documentation

• Go to /easy_swagger on your Easy8 instance.
• Locate the sections:
  • Custom table API
  • Custom entity API (for records)

Step 2: Use the available endpoints

• GET /custom_tables: List of Custom tables
• POST /custom_tables: Create new table
• PUT /custom_tables/{id}: Update table
• DELETE /custom_tables/{id}: Delete table
• GET /custom_entities: List of records
• POST /custom_entities: Create new record
• PUT /custom_entities/{id}: Update record
• DELETE /custom_entities/{id}: Delete record

How to Synchronize Data Using Webhooks

Step 1: Go to Webhook settings

• Navigate to Easy WebHooks from the Global menu.
• Click New Easy Web Hook.

Step 2: Create the webhook

• In the form:
  • Select the Project (if applicable).
  • Set Entity to CustomEntity.
  • Choose the Action (create, update, delete).
  • Enter the target URL (must begin with http:// or https://).
  • Select the related Custom table.
• Click Save.

Step 3: Activate and monitor

• Ensure the webhook is set to Active.
• Trigger test changes in the table to confirm webhook delivery.

Troubleshooting

• Confirm the webhook URL is publicly accessible.
• Ensure the API user has permissions for CustomEntity and CustomTable.
• Use /easy_swagger to check endpoint structure and required parameters.

Conclusion

You have successfully integrated and synchronized your Custom table data using either the API or Easy WebHooks in Easy8.

Related Topics and Further Reading

• Asset and Configuration Management Settings and Options (Reference)
• How to Import Data to Custom Table (How-To)
• How to Export Custom Table Configuration (How-To)

How would you rate this article?