Create Webhook

Description

Webhooks allow EVO to notify external systems whenever a specific event occurs. This enables integration with other systems and automates actions based on captured events.

NOTE. Available for use with branch access key and also with General ADM access key.
🚧 The webhook is not created automatically for all branches, even when using a General Admin key. To configure the webhook for multiple units, register it individually for each branch, providing the corresponding idBranch.

📨 Request Body

Parameter	Type	Description
idBranch	String	Number of the branch where the webhook will be registered. Only available when using a multi-location access key; ignored otherwise.
eventType	String	Specifies the type of event that will trigger this webhook.
urlCallback	String	URL that will be called after the event occurs. The API receiving the request must accept the POST type and the content in the specified format.
headers	Arrayobject	Optional. List of custom headers that will be included in the request. Each header is an object with `name` (type: string) and `value` (type: string).
filters	Arrayobject	Optional. List of filters applicable only for webhooks of type 'NewSale'. Read the explanation below.

🧩 Structure of the `filters` Object

Each filter must be an object with the fields:

Parameter	Type	Description
`filterType`	string	Type of filter to be applied. Currently, the available type is `SaleItemDescription`.
`value`	string	Value used for filtering. The match is made by contains (substring), meaning if the provided value is present anywhere in the sale item description, the filter will be satisfied.

📄 Rules for Evaluating Multiple Filters

When more than one filter is registered, validation is done as an OR condition. Example:

"filters": [
  { "FilterType": "SaleItemDescription", "Value": "ANUAL" },
  { "FilterType": "SaleItemDescription", "Value": "MENSAL" }
]

In this case, the webhook will be triggered whenever the sale item description contains "ANUAL" or "MENSAL".

📤🪝 Payload received after the Webhook is triggered

Whenever a configured event occurs, EVO will make an HTTP POST request to the urlCallback provided in the webhook registration, sending a standard event notification object in the request body.

Field	Type	Description
`IdW12`	int32	Identifier of the W12 account (company) where the event occurred.
`IdBranch`	int32	Identifier of the branch related to the event.
`IdRecord`	int32	Identifier of the record generated by the event (e.g., sale ID, membership, customer, etc.).
`EventType`	string	Type of event that triggered the webhook. The value varies according to the configured event (e.g., `NewSale`).
`ApiCallback`	string	Endpoint of the EVO Integration API where you can consult the complete data of the occurred event.

📝 Example of Payload

{
  "IdW12": 123,
  "IdBranch": 1,
  "IdRecord": 123,
  "EventType": "NewSale",
  "ApiCallback": "https://evo-integracao-api.w12app.com.br/api/v1/sales/123"
}

The format of the object is always the same for all events. The only variations are:

EventType: takes the name of the event that was triggered.

ApiCallback: each type of event has a specific endpoint for detailed consultation in the Integration API.

Available Events

🏋️ Activities and Accesses

eventType	Description	Received ID
EndedSessionActivity	Triggered whenever a session of the Schedule is finalized.	`idActivitySession`
Entries	Triggered whenever a passage is registered by access control.	`IdEntry`
ActivityEnroll	Triggered whenever a member schedules for an activity in the schedule.	`idSession`
SpotAvailable	Triggered whenever an activity in the schedule, previously full, becomes available.	`idActivitySession`
AppointmentEnroll	Triggered whenever there is a new scheduling of activity in the scheduling module (EVO, Site/Totem/Fiti/API).	`idActivitySession`
CancelAppointment	Triggered whenever there is a cancellation of scheduling of activity in the scheduling module (EVO, Site/Totem/Fiti/API).	`idActivitySession`
EndedSessionAppointment	Triggered whenever the scheduled activity is finalized in EVO (manually or via cron job).	`idActivitySession`

👤 Customers (Members)

eventType	Description	Received ID
CreateMember	Triggered whenever an opportunity is converted into a customer.	`idMember`
AlterMember	Triggered whenever personal information of a customer is altered or when the customer is deleted. Note: Does not include change of status from active to inactive.	`idMember`
Freeze	Triggered whenever a suspension is made on a member or when the suspension is removed.	`idMemberMembership`
TransferMember	Triggered whenever a customer (member) is transferred from one branch to another.	`idMember`

📄 Contracts (Membership and MemberMembership)

eventType	Description	Received ID
CreateMembership	Triggered whenever a new type of contract is created.	`idMembership`
AlterMembership	Triggered whenever a contract information is altered.	`idMembership`
ScheduleCancelMembership	Triggered whenever there is a scheduling of contract cancellation.	`idMemberMembership`
CancelMembership	Triggered whenever a contract is canceled.	`idMemberMembership`

💳 Financial

eventType	Description	Received ID
ClearedDebt	Triggered whenever a customer makes a payment of an overdue balance, that is, only when the payment occurs AFTER the due date, either manually by reception or by automated system collection.	`idSale`
AlterReceivables	Triggered whenever the information of a receivable in Accounts Receivable is manually edited. Automatic updates, such as payment status changes, do not trigger this event.	`idReceivable`
NewInvoice	Triggered whenever a new invoice sent for issuance is actually issued (regardless of whether it was created by recurring sale, one-off sale, or manual entry).	`id`
CancelInvoice	Triggered whenever an existing invoice in the system with issued status is canceled.	`id`

🎯 Opportunities (Prospects)

eventType	Description	Received ID
TransferProspect	Triggered whenever an opportunity (prospect) is transferred from one branch to another.	`idProspect`

📦 Products

eventType	Description	Received ID
CreateProduct	Triggered whenever a new type of product is created.	`id`
AlterProduct	Triggered whenever a type of product is altered.	`id`

🛠️ Services

eventType	Description	Received ID
CreateService	Triggered whenever a new type of service is created.	`idService`
AlterService	Triggered whenever a type of service is altered.	`idService`

🛒 Sales

eventType	Description	Received ID
NewSale	Triggered whenever a new sale is made in the EVO system or through the Site/Totem. Note: Does not include sales generated automatically by recurrence.	`idSale`
RecurrentSale	Triggered whenever a contract is automatically renewed in the recurrence.	`idSale`
SalesItensUpdated	Triggered whenever a new sale item is added to a Sales Page.	`idSaleItem`

Request

Authorization

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Body Params

application/json-patch+json

Example

{
    "idBranch": 0,
    "eventType": "string",
    "urlCallback": "string",
    "headers": [
        {
            "nome": "string",
            "valor": "string"
        }
    ],
    "filters": [
        {
            "filterType": "string",
            "value": "string"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Add new webhook

Create Webhook

Description

📨 Request Body

🧩 Structure of the `filters` Object

📄 Rules for Evaluating Multiple Filters

📤🪝 Payload received after the Webhook is triggered

📝 Example of Payload

Available Events

🏋️ Activities and Accesses

👤 Customers (Members)

📄 Contracts (Membership and MemberMembership)

💳 Financial

🎯 Opportunities (Prospects)

📦 Products

🛠️ Services

🛒 Sales

Request

Request Code Samples

Responses

Add new webhook

Create Webhook#

Description#

📨 Request Body#

🧩 Structure of the filters Object#

📄 Rules for Evaluating Multiple Filters#

📤🪝 Payload received after the Webhook is triggered#

📝 Example of Payload#

Available Events#

🏋️ Activities and Accesses#

👤 Customers (Members)#

📄 Contracts (Membership and MemberMembership)#

💳 Financial#

🎯 Opportunities (Prospects)#

📦 Products#

🛠️ Services#

🛒 Sales#

Request

Request Code Samples

Responses

Create Webhook

Description

📨 Request Body

🧩 Structure of the `filters` Object

📄 Rules for Evaluating Multiple Filters

📤🪝 Payload received after the Webhook is triggered

📝 Example of Payload

Available Events

🏋️ Activities and Accesses

👤 Customers (Members)

📄 Contracts (Membership and MemberMembership)

💳 Financial

🎯 Opportunities (Prospects)

📦 Products

🛠️ Services

🛒 Sales