How to Configure the Webhook Action

The “Trigger Webhook” action allows you to integrate octapipe with external systems by sending data automatically whenever defined rules and events are triggered.

1st Step: Accessing the Automations Administration Module

In the lower left side menu, click “Automations” to view the list.

2nd Step: Creating or Editing an Automation

Click “New Automation” to create a rule or select an existing automation to edit.

3rd Step: Defining Entity and Event

Select the Entity that will be monitored (e.g., Pipeline Cards, Database Records, Tasks, or Users). 

Choose the Event that will trigger the automation:

• Create
• Update
• Delete
• Move
• Task Completed
• All Tasks Completed Each entity has its own events that can be used depending on the context.

4th Step: Selecting the Action

In the “Action” field, choose “Trigger Webhook”.

5th Step: Applying Conditions (Optional)

If necessary, add conditions to restrict when the webhook should be triggered. Configure:

• Field
• Operator
• Value

6th Step: Configuring the Webhook

In the “Settings” section, fill in the fields:

Method: choose the HTTP method to be used (GET, POST, PUT, DELETE).

• Endpoint: enter the URL of the external service that will receive the data.
• Headers: add authentication headers or additional parameters if needed.
• Body: define the request body. You can insert text, JSON, or other data structures.

You can use dynamic variables represented by the (x) icon next to the field to automatically personalize the content, inserting information such as customer name, card owner, or order number.

7th Step: Saving the Automation

After reviewing, click “Create Automation”.

The rule will become active and will trigger the webhook whenever the configured event and conditions are met.

Best Practices:

• Test the endpoint using tools like Postman before integrating it into the automation.
• Use variables to send dynamic data in the request body.
• Configure authentication headers for secure connections.
• Monitor external system logs to validate received requests.

Conclusion:

You have learned how to configure the webhook action in an automation by defining method, endpoint, headers, and request body, along with using dynamic variables. This feature expands octapipe’s integration capabilities with external systems. If you have any questions, contact our support team.