API Connectors (Webhooks)

Events, Endpoints, Synchronization, Automation, Parameters, State management

Description: This tool allows the system to send automatic real-time notifications to external applications and services whenever a specific event occurs within Framework360.

What is it for? (Practical examples)

API Connectors are essential for automating the data flow between Framework360 and other business software, reducing manual work and ensuring that all systems are synchronized.

  • CRM Synchronization: Use it to notify your Customer Relationship Management (CRM) every time a new user registers or a potential customer fills out a form.
  • Order and Inventory Management: Automatically send the details of a completed order to your warehouse management system or billing software.
  • Marketing Automation: Trigger complex workflows on external platforms (e.g., sending SMS, creating tasks) as soon as a customer reaches a certain goal.

Main Features

The management of API Connectors is structured into the following functions:

  • List and Status: Quick view of all configured connectors, including the type of monitored event, the destination address, and the status (Active/Inactive).
  • Event Definition: Ability to select from a predefined list which internal event (e.g., 'New User', 'Order Paid', etc.) should trigger the notification.
  • Destination Address (Endpoint): Setting the exact URL of the external service that must receive the data.
  • Data Customization: Ability to precisely define which additional information should be sent (POST data) and how it should be sent (HEADER parameters).
  • Activation/Deactivation: Immediate control over the connector's operation without needing to delete it.

How to configure

To create or modify an API Connector, you need to fill in the following fields:

FieldDescriptionNotes
TypeSelect the specific event within Framework360 that should trigger the notification.Example: "When a user registers".
Destination URLThe web address (Endpoint) of the external system that will receive the data.This field is mandatory and must be a valid URL.
ActiveCheck this box to make the connector operational.If unchecked, the connector will not send notifications.

Custom parameters

This section allows you to define additional data and instructions for the external application. These fields require data input in a structured format (JSON) to ensure the receiving system can interpret them correctly.

SectionPurpose
POST ParametersData sent in the body of the request. Used to transmit specific payload information (e.g., authentication keys or additional data not included automatically).
HEADER ParametersAdditional information sent in the request header. Often used for API authentication (tokens) or to specify the data format.

Important: The data entered in these sections must strictly comply with the required format. Otherwise, the system will not save the configuration and will display an error message.

Automatic integrations

This module is the heart of real-time automations.

When the event selected in the Type occurs (e.g., a customer completes a purchase), the system automatically performs the following operations:

1. Collects information related to the event.

2. Builds a data request including any defined Custom Parameters.

3. Sends this request to the specified Destination URL, ensuring the external application is informed immediately.

This process runs in the background and requires no manual interaction from the user after the initial setup.