Module results

For asynchronous modules (MFA, for example) and for post-hoc queries of synchronous modules (Score and Insights, for example), Connect provides two routes: by Order ID and by Analysis ID.

Search by Analysis ID

This route returns the execution status of the contracted modules by Analysis ID.

📘

Our service addresses:

Homologation:

GET https://homologapix.clearsale.com.br/connect/v1/integration/analysis/[analysisId]

Production:

GET https://apix.clearsale.com.br/connect/v1/integration/analysis/[analysisId]

Webhook Flow

The webhook allows the system to send automatic notifications to an endpoint defined by the client whenever a specific action or event occurs in one of the asynchronous modules. This feature is essential to ensure that the client receives real-time updates, integrating the data directly into their business flow.

To configure a webhook, you must provide:

• The endpoint URL that should receive the data.

The available modules are:

Retry Flow

If the integrator's URL returns any HTTP status other than 200 (OK), the Clearsale system will make new notification attempts for the same request.

These retries will continue until a response with status 200 is received, indicating successful processing. The interval between attempts will be progressively increased according to the number of previous failures, following a backoff strategy to avoid overloading the integrator's system.

Endpoint Authentication

If the provided endpoint requires authentication, the client must provide the necessary credentials so that the system can authenticate and send the data successfully. The supported authentication types are:

Basic Authentication The client must provide a username and password, which will be converted into a Base64 string and added to the request header.

Where dXN1YXJpbzpwYXNzZW5oYQ== is the Base64 encoding of user:password.

Bearer Token (JWT) The client must provide a valid JWT token.

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

🚧

Note: The system does not perform authentication to generate the token.

API Key The client must provide a key and value, which will be included in the request header as a key: value pair.

x-api-key: abc123xyz456

Request

POST https://exemple-clearsale.com.br/analysis-result
Content-Type: application/json 

{
  "analysisId": "string",
  "date": "2025-09-26T17:21:11.0367845Z",
  "type": "mfa" //module
}