Webhook

A webhook is a way to receive real-time notifications of events occurring in another system. When you register a webhook, you provide a destination URL, and whenever an event occurs (for example, the registration of a new member or contract update), the system sends an HTTP request to that URL with the event data.

This allows you to automate actions in your system, such as:

Automatically update your database when a new contract is created

Send internal notifications to staff members

Integrate system events with other tools or dashboards

Usage example:

You register a webhook pointing to https://meusistema.com/webhooks/new-contract.

When a customer makes a new contract, the system sends a POST to that URL with the contract data.

Your system processes the event and, for example, sends an email to the responsible consultant or updates the sales dashboard.

Available Endpoints

Method	Endpoint	Description
`POST`	`/api/v1/webhook`	Adds a new webhook, registering the URL that will receive events from the system.
`GET`	`/api/v2/webhook`	Lists all registered webhooks, allowing you to track which URLs are active and which events they receive.
`DELETE`	`/api/v1/webhook`	Removes a specific webhook by its ID, stopping the sending of events to that URL.

Available Endpoints#

Available Endpoints