Webhooks

Clickmax has two kinds of webhook: inbound (in), which receives events from an external platform, and outbound (out), which sends an event from Clickmax to an external URL when a trigger fires.

Role required: authenticated workspace member. Webhooks are managed in the Integrations area.

Direction

Type	Direction	What it is
`in`	External platform → Clickmax	Receives data through a dedicated URL (`https://webhooks.<your-domain>/<slug>`), validated by token.
`out`	Clickmax → external platform	Fires a `POST` to the configured URL when the trigger occurs.

Inbound platforms

Values accepted when creating an inbound webhook.

Platform	Identifier	How to set up
ActiveCampaign	`activecampaign`	—
Asaas	`asaas`	—
Braip	`braip`	—
CartPanda	`cartpanda`	—
Eduzz	`eduzz`	Integrate Eduzz
Greenn	`greenn`	—
Digital Manager Guru	`guru`	Integrate Guru
Hotmart	`hotmart`	Integrate Hotmart
HotWebinar	`hotwebinar`	—
Hubla	`hubla`	Integrate Hubla
Kirvano	`kirvano`	Integrate Kirvano
Kiwify	`kiwify`	Integrate Kiwify
Kommo	`kommo`	—
Lastlink	`lastlink`	Integrate Lastlink
ManyChat	`manychat`	—
Monetizze	`monetizze`	—
Nuvemshop	`nuvemshop`	Integrate Nuvemshop
Pagar.me	`pagarme`	Integrate Pagar.me
PerfectPay	`perfectpay`	—
Principia	`principia`	Integrate Principia
Shopify	`shopify`	Integrate Shopify
Stripe	`stripe`	Integrate Stripe
Ticto	`ticto`	Integrate Ticto
TMB (Tem Mais no Boleto)	`tmb`	—
Voomp	`voomp`	Integrate Voomp
VStage	`vstage`	—
Vunel	`vunel`	—
WebinarKit	`webinarkit`	—
Whop	`whop`	Integrate Whop
Yampi	`yampi`	—
Yever	`yever`	Integrate Yever

Outbound platforms

Destinations accepted when creating an outbound webhook.

Platform	Identifier
ActiveCampaign	`activecampaignout`
Basecamp	`basecamp`
Calendly	`calendly`
Circle	`circle`
Clickmax (internal funnel/tag)	`clickmax`
Discord	`discord`
Google Drive	`drive`
Dropbox	`dropbox`
Eventbrite	`eventbrite`
Google Sheets	`googlesheets`
HubSpot	`hubspot`
Intercom	`intercom`
JivoChat	`jivochat`
Make	`make`
n8n	`n8n`
Nibo	`nibo`
Nota do Infoprodutor	`notadoinfoprodutor`
Notazz	`notazz`
Notion	`notion`
Outsider	`outsider`
Pipedrive	`pipedrive`
PipeRun	`piperun`
Pluga	`pluga`
QuickBooks	`quickbooks`
RD Station	`rdstation`
Shopify	`shopify`
Slack	`slack`
Somos BIU	`somosbiu`
UTMify	`utmify`
VK Metrics	`vkmetrics`
WooCommerce	`woocommerce`
Zapier	`zapier`
Zendesk	`zendesk`
Zoom Webinar	`zoomwebinar`

Triggers

Events that fire an outbound webhook (the trigger field).

Trigger	When it fires
`ABANDONED_CART`	Cart abandoned
`CHARGEBACK_REQUESTED`	Chargeback requested
`FUNNEL_CREATED`	Funnel created
`FUNNEL_DELETED`	Funnel deleted
`FUNNEL_EDITED`	Funnel edited
`LEAD_CAPTURED`	Lead captured
`LEAD_CREATED`	Lead created
`PAGE_DELETED`	Page deleted
`PIX_OR_BOLETO_EXPIRED_OR_OVERDUE`	Pix or Boleto expired/overdue
`PROJECT_CREATED`	Project created
`PROJECT_DELETED`	Project deleted
`REFUND_MADE`	Refund issued
`REFUSED_CARD`	Card declined on the charge (once per attempt)
`SALE_CANCELLED`	Sale cancelled
`SALE_MADE`	Sale completed
`SUBSCRIPTION_CANCELLED`	Subscription cancelled
`SUBSCRIPTION_STARTED`	Subscription started
`TAG_ADDED`	Tag added
`TAG_REMOVED`	Tag removed
`TRANSACTION_FAILED`	Transaction failed

Card declined vs transaction failed

REFUSED_CARD fires once per payment attempt in which the card was sent to the charge and refused. A second attempt by the buyer with the same card, minutes later, is a new refusal and fires again.

A purchase that never reaches the charge — required card missing, product out of stock, pending seller account, missing delivery address — is not a card refusal: it only fires TRANSACTION_FAILED. Pix and Boleto failures also use TRANSACTION_FAILED only.

Purchase or renewal invoice in `SALE_MADE`

SALE_MADE fires on the purchase and also on every paid renewal invoice of a subscription, from the second charge on. The isSubscriptionInvoice field tells them apart: false on the purchase, true on the renewal invoice.

On renewal invoices of subscriptions sold on your checkout, the body also carries subscriptionId, subscriptionExternalId (subscription code in the gateway), occurrence and purchaseDate (date of the original purchase). On those invoices, saleDate is the date of the installment charge.

The occurrence field is the charge number reported by the gateway and may skip numbers, because the gateway also counts a resent overdue charge. To know which cycle the subscription is in, count the invoices received with the same subscriptionId.

When `SUBSCRIPTION_CANCELLED` fires

On any subscription cancellation, whatever its origin: cancelled by the buyer, by you or by support, the automatic cancellation for missed payment after the tolerance period, and the cancellation that comes with a refund.

A subscription that reached the end of its contracted duration (the plan's last scheduled charge) is not a cancellation and does not fire this trigger.

Request format (outbound)

When a trigger fires, Clickmax sends a request to the integration URL in this format:

Item	Value
Method	`POST`
URL	The URL saved on the integration, exactly as entered (query string included).
`Content-Type`	`application/json`
`cm-token`	The integration token, shown on the webhook settings screen.
Body	JSON object with the event fields, described in Body of each event.

Authentication

The request is authenticated by the cm-token header. On your endpoint, compare the received value with the token shown on the integration and reject the request (for example, with 401) if they differ. The token is fixed per integration; there is no HMAC signature of the body.

How to tell which event arrived

The body does not carry the trigger name. One integration can listen to several triggers and all of them arrive at the same URL, so use one of these options to know which event arrived:

create one integration per trigger, each with a different URL (for example, https://your-system.com/webhook?event=SALE_MADE);
or tell them apart by the body fields, which differ from one event to another (see the tables below).

Response, retries and deactivation

Any 2xx response counts as a completed delivery (COMPLETED). The response content is kept in the history.
Any other response (such as 4xx or 5xx) or a connection failure triggers a retry. There are up to 3 attempts per event, with a growing wait between them (about 10 and 20 seconds). While waiting, the record is DELAYED; after the last failure, FAILED.
If the integration's last 15 attempts fail, it is deactivated automatically. Fix the endpoint, reactivate the integration and resend the records from the history.
Respond quickly and process the event afterwards: the same event may arrive more than once (for example, on a manual resend), so handle the body idempotently, using IDs such as transactionId or leadId.

Platforms with their own format

The format above applies to generic destinations (Zapier, Make, n8n, Pluga, your own system's URL, etc.). ActiveCampaign, Nota do Infoprodutor, Notazz, UTMify and VK Metrics receive the event already converted to the format and authentication each platform requires, and do not follow the tables below.

Body of each event

Each table lists the fields exactly as they arrive in the JSON:

Required: the field is always in the body. When it is No, the field may be missing from the JSON.
Accepts null: the field may arrive with the value null.
May be empty: the text field may arrive as an empty string (""), for example when the data was not collected.
parent.child fields are inside an object; parent[].child fields are in each item of a list.
Dates are ISO 8601 strings in UTC (for example, 2026-01-15T14:30:00.000Z).
Money amounts are integers in cents (9700 = 97.00). The currency is not sent.

The examples use fictitious data. They are the same bodies sent by the integration's test button, except IDs and dates, which the test generates on the fly.

Lead created and lead captured

Triggers: LEAD_CREATED, LEAD_CAPTURED.

LEAD_CREATED fires once, when the lead comes into existence. LEAD_CAPTURED fires on every capture, including when an existing lead fills in a form again. Fields with no value on the lead are left out of the body.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`fullname`	string	No	No	No	Lead full name.
`email`	string (e-mail)	No	No	No	Lead e-mail.
`telephone`	string	No	No	No	Lead phone, as digits (may start with `+`).
`pageId`	string (UUID)	No	No	No	ID of the capture page. Missing when the capture did not happen on a page (for example, through the site chat).
`pageUrl`	string	No	No	No	Full address of the capture page, with `https://`.
`pageName`	string	No	No	No	Capture page name.
`funnelId`	string (UUID)	No	No	No	ID of the page funnel.
`funnelName`	string	No	No	No	Page funnel name.
`utmSource`	string	No	No	No	Visit `utm_source` parameter.
`utmMedium`	string	No	No	No	Visit `utm_medium` parameter.
`utmCampaign`	string	No	No	No	Visit `utm_campaign` parameter.
`utmTerm`	string	No	No	No	Visit `utm_term` parameter.
`utmContent`	string	No	No	No	Visit `utm_content` parameter.
`extraParams`	object	No	No	—	Partner tracking parameters, besides UTMs.
`extraParams.vkSource`	string	No	No	No	Visit `vk_source` parameter (VK Metrics).
`extraParams.vkAdId`	string	No	No	No	Visit `vk_adid` parameter (VK Metrics).
`src`	string	No	No	No	Free `src` URL parameter, used by tools such as VTurb and UTMify to attribute the conversion.
`sck`	string	No	No	No	Free `sck` URL parameter, used to attribute the conversion.
`capturedAt`	string (ISO 8601)	Yes	No	No	Date and time Clickmax processed the capture.

Example body:

{
  "fullname": "Fullname",
  "email": "example@email.com",
  "telephone": "9538374457",
  "pageId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "pageUrl": "https://clickmax.io",
  "pageName": "Page name",
  "funnelId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
  "funnelName": "Funnel name",
  "utmSource": "source",
  "utmMedium": "medium",
  "utmCampaign": "campaign",
  "utmTerm": "term",
  "utmContent": "content",
  "src": "vturb_vsl_01",
  "sck": "lote2",
  "capturedAt": "2026-01-15T14:30:00.000Z"
}

Sale made

Triggers: SALE_MADE.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`email`	string (e-mail)	Yes	No	No	Buyer e-mail.
`document`	string	No	Yes	No	Buyer's CPF (11 digits) or CNPJ (14 digits), digits only.
`firstName`	string	Yes	No	No	Buyer first name.
`lastName`	string	Yes	No	Yes	Buyer last name. Empty when only one name was given.
`phone`	string	Yes	No	Yes	Buyer phone: country code, area code and number, digits only.
`city`	string	No	Yes	No	Buyer city.
`state`	string	No	Yes	No	Buyer state.
`country`	string	No	Yes	No	Buyer country, two-letter ISO code (for example, `BR`).
`address`	string	Yes	No	Yes	Buyer address on one line: street, number, complement, neighborhood and ZIP code, comma-separated. Empty when no address was given.
`offerId`	string (UUID)	Yes	No	No	Offer ID.
`productId`	string (UUID)	Yes	No	No	Product ID.
`productName`	string	Yes	No	No	Product name.
`saleDate`	string (ISO 8601)	Yes	No	No	Date and time the transaction was created. On a renewal invoice, it is the date of this charge.
`price`	number	Yes	No	—	Amount in cents. On a checkout purchase it is the offer price, without coupon discounts; on invoice and renewal charges, it is the charged amount.
`utmSource`	string	Yes	No	Yes	Visit `utm_source` parameter.
`utmMedium`	string	Yes	No	Yes	Visit `utm_medium` parameter.
`utmCampaign`	string	Yes	No	Yes	Visit `utm_campaign` parameter.
`utmTerm`	string	Yes	No	Yes	Visit `utm_term` parameter.
`utmContent`	string	Yes	No	Yes	Visit `utm_content` parameter.
`src`	string	Yes	No	Yes	Free `src` URL parameter, used by tools such as VTurb and UTMify to attribute the conversion.
`sck`	string	Yes	No	Yes	Free `sck` URL parameter, used to attribute the conversion.
`pageUrl`	string	Yes	No	No	Address of the sale checkout page.
`pageName`	string	Yes	No	Yes	Checkout page name. Empty when the sale did not come from an editor page.
`gateway`	string	Yes	No	No	Payment gateway of the transaction (for example, `IOPAY` or `TICTO`). Compare case-insensitively.
`orderBumps`	array	Yes	No	—	Order bumps bought together. Empty list when there were none.
`orderBumps[].offerId`	string (UUID)	Yes	No	No	Order bump offer ID.
`orderBumps[].productId`	string (UUID)	Yes	No	No	Order bump product ID.
`orderBumps[].price`	number	Yes	No	—	Order bump price, in cents.
`orderBumps[].productName`	string	Yes	No	No	Order bump product name.
`transactionId`	string (UUID)	Yes	No	No	Transaction ID.
`isSubscriptionInvoice`	boolean	Yes	No	—	`true` when the sale is a subscription renewal invoice (from the second charge on); `false` on a purchase.
`subscriptionId`	string (UUID)	No	No	No	Renewal invoice only. Subscription ID in Clickmax (the same `subscriptionId` of `SUBSCRIPTION_CANCELLED` and `transactionId` of `SUBSCRIPTION_STARTED`).
`subscriptionExternalId`	string	No	No	No	Renewal invoice only. Subscription code in the payment gateway.
`occurrence`	integer	No	Yes	—	Renewal invoice only. Charge number reported by the gateway; it may skip numbers, because the gateway also counts a resent overdue charge.
`purchaseDate`	string (ISO 8601)	No	No	No	Renewal invoice only. Date and time of the original subscription purchase.

Example body:

{
  "email": "example@email.com",
  "document": "12345678909",
  "firstName": "First Name",
  "lastName": "Last Name",
  "phone": "5538933008932",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "address": "Avenida Paulista, 1000, Sala 123, Bela Vista, 01310-100",
  "offerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "productId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
  "productName": "Product Name",
  "saleDate": "2026-01-15T14:30:00.000Z",
  "price": 9700,
  "utmSource": "source",
  "utmMedium": "medium",
  "utmCampaign": "campaign",
  "utmTerm": "term",
  "utmContent": "content",
  "src": "vturb_vsl_01",
  "sck": "lote2",
  "pageUrl": "https://test.clickmax.io/test-clickmax",
  "pageName": "Test Clickmax",
  "gateway": "iopay",
  "orderBumps": [
    {
      "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
      "productId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
      "price": 2700,
      "productName": "Product Name"
    }
  ],
  "transactionId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
  "isSubscriptionInvoice": true,
  "subscriptionId": "1fd8c3f0-8d15-4228-951f-f1d6c5df1015",
  "subscriptionExternalId": "SUB-8F3K2L",
  "occurrence": 3,
  "purchaseDate": "2025-11-16T14:30:00.000Z"
}

Sale cancelled, refund and chargeback

Triggers: SALE_CANCELLED, REFUND_MADE, CHARGEBACK_REQUESTED.

The three triggers send the same body; only the reason changes. Set up one URL per trigger to tell them apart.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`buyerId`	string (UUID)	Yes	No	No	Buyer ID in Clickmax.
`leadId`	string (UUID)	Yes	No	No	Lead ID in Clickmax.
`email`	string (e-mail)	Yes	No	No	Buyer e-mail.
`name`	string	Yes	No	No	Buyer name.
`phone`	string	Yes	No	No	Buyer phone: country code, area code and number.
`document`	string	No	Yes	No	Buyer's CPF (11 digits) or CNPJ (14 digits), digits only.
`city`	string	No	Yes	No	Buyer city.
`state`	string	No	Yes	No	Buyer state.
`country`	string	No	Yes	No	Buyer country, two-letter ISO code (for example, `BR`).
`address`	string	Yes	No	Yes	Buyer address on one line: street, number, complement, neighborhood and ZIP code, comma-separated. Empty when no address was given.
`offerId`	string (UUID)	Yes	No	No	Offer ID.
`productId`	string (UUID)	Yes	No	No	Product ID.
`productName`	string	Yes	No	No	Product name.
`price`	number	Yes	No	—	Offer list price, in cents.
`transactionId`	string (UUID)	Yes	No	No	Transaction ID.
`gateway`	string	Yes	No	No	Payment gateway of the transaction (for example, `IOPAY` or `TICTO`). Compare case-insensitively.
`cancelledDate`	string (ISO 8601)	Yes	No	No	Date and time Clickmax processed the cancellation, refund or chargeback.
`utmSource`	string	No	No	No	Visit `utm_source` parameter.
`utmMedium`	string	No	No	No	Visit `utm_medium` parameter.
`utmCampaign`	string	No	No	No	Visit `utm_campaign` parameter.
`utmTerm`	string	No	No	No	Visit `utm_term` parameter.
`utmContent`	string	No	No	No	Visit `utm_content` parameter.
`src`	string	No	No	No	Free `src` URL parameter, used by tools such as VTurb and UTMify to attribute the conversion.
`sck`	string	No	No	No	Free `sck` URL parameter, used to attribute the conversion.

Example body:

{
  "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
  "email": "example@email.com",
  "name": "Buyer Name",
  "phone": "5538933008932",
  "document": "12345678900",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "address": "Avenida Paulista, 1000, Sala 123, Bela Vista, 01310-100",
  "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
  "productId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
  "productName": "Product Name",
  "price": 9700,
  "transactionId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
  "gateway": "iopay",
  "cancelledDate": "2026-01-15T14:30:00.000Z",
  "utmSource": "source",
  "utmMedium": "medium",
  "utmCampaign": "campaign",
  "utmTerm": "term",
  "utmContent": "content",
  "src": "vturb_vsl_01",
  "sck": "lote2"
}

Subscription started

Triggers: SUBSCRIPTION_STARTED.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`email`	string (e-mail)	Yes	No	No	Buyer e-mail.
`document`	string	No	Yes	No	Buyer's CPF (11 digits) or CNPJ (14 digits), digits only.
`firstName`	string	Yes	No	No	Buyer first name.
`lastName`	string	Yes	No	Yes	Buyer last name. Empty when only one name was given.
`phone`	string	Yes	No	Yes	Buyer phone: country code, area code and number, digits only.
`offerId`	string (UUID)	Yes	No	No	Offer ID.
`orderBumps`	array	Yes	No	—	Order bumps bought together. Empty list when there were none.
`orderBumps[].offerId`	string (UUID)	Yes	No	No	Order bump offer ID.
`orderBumps[].productId`	string (UUID)	Yes	No	No	Order bump product ID.
`orderBumps[].price`	number	Yes	No	—	Order bump price, in cents.
`orderBumps[].productName`	string	Yes	No	No	Order bump product name.
`transactionId`	string (UUID)	Yes	No	No	ID of the created subscription (the same sent as `subscriptionId` in `SUBSCRIPTION_CANCELLED`).
`utmSource`	string	No	No	No	Visit `utm_source` parameter.
`utmMedium`	string	No	No	No	Visit `utm_medium` parameter.
`utmCampaign`	string	No	No	No	Visit `utm_campaign` parameter.
`utmTerm`	string	No	No	No	Visit `utm_term` parameter.
`utmContent`	string	No	No	No	Visit `utm_content` parameter.
`src`	string	No	No	No	Free `src` URL parameter, used by tools such as VTurb and UTMify to attribute the conversion.
`sck`	string	No	No	No	Free `sck` URL parameter, used to attribute the conversion.

Example body:

{
  "email": "example@email.com",
  "document": "12345678900",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "5538933008932",
  "offerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "orderBumps": [
    {
      "offerId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
      "productId": "d3429377-199d-4075-aa4c-9a32d327a877",
      "price": 2700,
      "productName": "Product Name"
    }
  ],
  "transactionId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
  "utmSource": "source",
  "utmMedium": "medium",
  "utmCampaign": "campaign",
  "utmTerm": "term",
  "utmContent": "content",
  "src": "vturb_vsl_01",
  "sck": "lote2"
}

Subscription cancelled

Triggers: SUBSCRIPTION_CANCELLED.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`buyerId`	string (UUID)	Yes	No	No	Buyer ID in Clickmax.
`leadId`	string (UUID)	Yes	No	No	Lead ID in Clickmax.
`email`	string (e-mail)	Yes	No	No	Buyer e-mail.
`name`	string	Yes	No	No	Buyer name.
`telephone`	string	Yes	No	No	Buyer phone: country code, area code and number.
`document`	string	No	Yes	No	Buyer's CPF (11 digits) or CNPJ (14 digits), digits only.
`city`	string	No	Yes	No	Buyer city.
`state`	string	No	Yes	No	Buyer state.
`country`	string	No	Yes	No	Buyer country, two-letter ISO code (for example, `BR`).
`address`	string	Yes	No	Yes	Buyer address on one line: street, number, complement, neighborhood and ZIP code, comma-separated. Empty when no address was given.
`productName`	string	Yes	No	No	Product name.
`price`	number	Yes	No	—	Offer list price, in cents.
`subscriptionStatus`	string	Yes	No	No	Subscription status before the cancellation (usually `active`).
`subscriptionId`	string (UUID)	Yes	No	No	Subscription ID.
`offerId`	string (UUID)	Yes	No	No	Offer ID.
`productId`	string (UUID)	Yes	No	No	Product ID.
`frequency`	string	Yes	No	No	Billing recurrence (for example, `monthly`, `quarterly`, `semiannual`, `yearly`).
`gateway`	string	Yes	No	No	Payment gateway of the transaction (for example, `IOPAY` or `TICTO`). Compare case-insensitively.
`cancelledDate`	string (ISO 8601)	Yes	No	No	Cancellation date and time.
`utmSource`	string	No	No	No	Visit `utm_source` parameter.
`utmMedium`	string	No	No	No	Visit `utm_medium` parameter.
`utmCampaign`	string	No	No	No	Visit `utm_campaign` parameter.
`utmTerm`	string	No	No	No	Visit `utm_term` parameter.
`utmContent`	string	No	No	No	Visit `utm_content` parameter.
`src`	string	No	No	No	Free `src` URL parameter, used by tools such as VTurb and UTMify to attribute the conversion.
`sck`	string	No	No	No	Free `sck` URL parameter, used to attribute the conversion.

Example body:

{
  "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
  "email": "example@email.com",
  "name": "Buyer Name",
  "telephone": "5538933008932",
  "document": "12345678900",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "address": "Avenida Paulista, 1000, Sala 123, Bela Vista, 01310-100",
  "productName": "Product Name",
  "price": 9700,
  "subscriptionStatus": "canceled",
  "subscriptionId": "d3429377-199d-4075-aa4c-9a32d327a877",
  "offerId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
  "productId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
  "frequency": "monthly",
  "gateway": "iopay",
  "cancelledDate": "2026-01-15T14:30:00.000Z",
  "utmSource": "source",
  "utmMedium": "medium",
  "utmCampaign": "campaign",
  "utmTerm": "term",
  "utmContent": "content",
  "src": "vturb_vsl_01",
  "sck": "lote2"
}

Abandoned cart

Triggers: ABANDONED_CART.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`leadId`	string (UUID)	Yes	No	No	Lead ID in Clickmax.
`leadName`	string	No	Yes	No	Lead name.
`leadEmail`	string (e-mail)	No	Yes	No	Lead e-mail.
`leadDocument`	string	No	Yes	No	Lead's CPF or CNPJ.
`leadCity`	string	No	Yes	No	Lead city.
`leadTelephone`	string	No	Yes	No	Lead phone, as digits (may start with `+`).
`leadWhatsappNumber`	string	No	Yes	No	Lead WhatsApp number, as digits.
`offerId`	string (UUID)	Yes	No	No	Offer ID.
`offerName`	string	Yes	No	No	Offer name.
`offerPrice`	number	Yes	No	—	Offer price, in cents.
`offerType`	string (enum)	Yes	No	No	Offer product type (for example, `course`, `ebook`, `software`). Possible values: `community`, `course`, `ebook`, `event`, `physical`, `other`, `services`, `software`, `consultancy`, `mentorship`.
`ownerId`	string (UUID)	Yes	No	No	Seller account ID.
`projectId`	string (UUID)	Yes	No	No	ID of the offer project.
`productId`	string (UUID)	Yes	No	No	Product ID.
`abandonedDate`	string (ISO 8601)	Yes	No	No	Date and time the abandonment was recorded.
`stage`	string (enum)	No	No	No	Checkout step where it stopped: `personal_data` (personal details) or `payment_data` (payment). Possible values: `personal_data`, `payment_data`.
`utmSource`	string	No	No	No	Visit `utm_source` parameter.
`utmMedium`	string	No	No	No	Visit `utm_medium` parameter.
`utmCampaign`	string	No	No	No	Visit `utm_campaign` parameter.
`utmTerm`	string	No	No	No	Visit `utm_term` parameter.
`utmContent`	string	No	No	No	Visit `utm_content` parameter.
`src`	string	No	No	No	Free `src` URL parameter, used by tools such as VTurb and UTMify to attribute the conversion.
`sck`	string	No	No	No	Free `sck` URL parameter, used to attribute the conversion.

Example body:

{
  "leadId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "leadName": "Lead Name",
  "leadEmail": "lead@email.com",
  "leadDocument": "12345678909",
  "leadCity": "City",
  "leadTelephone": "5538933008932",
  "leadWhatsappNumber": "5538933008932",
  "offerId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
  "offerName": "Meu produto",
  "offerPrice": 9700,
  "offerType": "software",
  "ownerId": "d3429377-199d-4075-aa4c-9a32d327a877",
  "projectId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
  "productId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
  "abandonedDate": "2026-01-15T14:30:00.000Z",
  "stage": "personal_data",
  "utmSource": "source",
  "utmMedium": "medium",
  "utmCampaign": "campaign",
  "utmTerm": "term",
  "utmContent": "content",
  "src": "vturb_vsl_01",
  "sck": "lote2"
}

Card refused

Triggers: REFUSED_CARD.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`buyerId`	string (UUID)	Yes	No	No	Buyer ID. Arrives as `00000000-0000-0000-0000-000000000000` when the buyer does not exist yet.
`leadId`	string (UUID)	Yes	No	No	Lead ID in Clickmax.
`offerId`	string (UUID)	Yes	No	No	Offer ID.
`offerName`	string	Yes	No	No	Offer name.
`offerPrice`	number	Yes	No	—	Offer price, in cents.
`offerType`	string	Yes	No	Yes	Offer product type (for example, `course`, `ebook`, `software`).
`buyerEmail`	string (e-mail)	Yes	No	No	Buyer e-mail.
`buyerName`	string	Yes	No	No	Buyer name.
`buyerTelephone`	string	Yes	No	Yes	Buyer phone, digits only (country code, area code and number).
`ownerId`	string (UUID)	Yes	No	No	Seller account ID.
`projectId`	string (UUID)	Yes	No	No	ID of the offer project.
`productId`	string (UUID)	Yes	No	No	Product ID.
`refusedDate`	string (ISO 8601)	Yes	No	No	Refusal date and time.
`failReason`	string	No	Yes	No	Reason returned by the gateway, when available.
`utmSource`	string	No	No	No	Visit `utm_source` parameter.
`utmMedium`	string	No	No	No	Visit `utm_medium` parameter.
`utmCampaign`	string	No	No	No	Visit `utm_campaign` parameter.
`utmTerm`	string	No	No	No	Visit `utm_term` parameter.
`utmContent`	string	No	No	No	Visit `utm_content` parameter.
`src`	string	No	No	No	Free `src` URL parameter, used by tools such as VTurb and UTMify to attribute the conversion.
`sck`	string	No	No	No	Free `sck` URL parameter, used to attribute the conversion.

Example body:

{
  "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
  "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
  "offerName": "Meu produto",
  "offerPrice": 9700,
  "offerType": "software",
  "buyerEmail": "buyer@email.com",
  "buyerName": "Buyer Name",
  "buyerTelephone": "5538933008932",
  "ownerId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
  "projectId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
  "productId": "1fd8c3f0-8d15-4228-951f-f1d6c5df1015",
  "refusedDate": "2026-01-15T14:30:00.000Z",
  "failReason": "Cartão recusado pela operadora",
  "utmSource": "source",
  "utmMedium": "medium",
  "utmCampaign": "campaign",
  "utmTerm": "term",
  "utmContent": "content",
  "src": "vturb_vsl_01",
  "sck": "lote2"
}

Transaction failed

Triggers: TRANSACTION_FAILED.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`buyerId`	string (UUID)	No	Yes	No	Buyer ID in Clickmax.
`leadId`	string (UUID)	No	Yes	No	Lead ID in Clickmax.
`offerId`	string (UUID)	Yes	No	No	Offer ID.
`offerName`	string	Yes	No	No	Offer name.
`offerPrice`	number	Yes	No	—	Offer price, in cents.
`offerType`	string	Yes	No	No	Offer product type (for example, `course`, `ebook`, `software`).
`buyerEmail`	string (e-mail)	Yes	No	No	Buyer e-mail.
`buyerName`	string	Yes	No	No	Buyer name.
`buyerTelephone`	string	No	Yes	No	Buyer phone. This event currently does not send the field.
`ownerId`	string (UUID)	Yes	No	No	Seller account ID.
`projectId`	string (UUID)	Yes	No	No	ID of the offer project.
`productId`	string (UUID)	Yes	No	No	Product ID.
`paymentType`	string	Yes	No	No	Payment method that failed (for example, `credit`, `pix`, `boleto`).
`failedDate`	string (ISO 8601)	Yes	No	No	Failure date and time.
`failReason`	string	No	Yes	No	Gateway error messages, separated by `;` , when available.
`utmSource`	string	No	No	No	Visit `utm_source` parameter.
`utmMedium`	string	No	No	No	Visit `utm_medium` parameter.
`utmCampaign`	string	No	No	No	Visit `utm_campaign` parameter.
`utmTerm`	string	No	No	No	Visit `utm_term` parameter.
`utmContent`	string	No	No	No	Visit `utm_content` parameter.
`src`	string	No	No	No	Free `src` URL parameter, used by tools such as VTurb and UTMify to attribute the conversion.
`sck`	string	No	No	No	Free `sck` URL parameter, used to attribute the conversion.

Example body:

{
  "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
  "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
  "offerName": "Meu produto",
  "offerPrice": 9700,
  "offerType": "software",
  "buyerEmail": "buyer@email.com",
  "buyerName": "Buyer Name",
  "buyerTelephone": "5538933008932",
  "ownerId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
  "projectId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
  "productId": "1fd8c3f0-8d15-4228-951f-f1d6c5df1015",
  "paymentType": "credit",
  "failedDate": "2026-01-15T14:30:00.000Z",
  "failReason": "Falha ao processar a transação",
  "utmSource": "source",
  "utmMedium": "medium",
  "utmCampaign": "campaign",
  "utmTerm": "term",
  "utmContent": "content",
  "src": "vturb_vsl_01",
  "sck": "lote2"
}

Pix or boleto expired or overdue

Triggers: PIX_OR_BOLETO_EXPIRED_OR_OVERDUE.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`buyerId`	string (UUID)	Yes	No	No	Buyer ID in Clickmax.
`leadId`	string (UUID)	Yes	No	No	Lead ID in Clickmax.
`offerId`	string (UUID)	Yes	No	No	Offer ID.
`offerName`	string	Yes	No	No	Offer name.
`offerPrice`	number	Yes	No	—	Offer price, in cents.
`offerType`	string	Yes	No	No	Offer product type (for example, `course`, `ebook`, `software`).
`buyerEmail`	string (e-mail)	Yes	No	No	Buyer e-mail.
`buyerName`	string	Yes	No	No	Buyer name.
`buyerDocument`	string	No	Yes	No	Buyer's CPF (11 digits) or CNPJ (14 digits), digits only.
`buyerTelephone`	string	Yes	No	Yes	Buyer phone, digits only (country code, area code and number).
`city`	string	No	Yes	No	Buyer city.
`state`	string	No	Yes	No	Buyer state.
`country`	string	No	Yes	No	Buyer country, two-letter ISO code (for example, `BR`).
`address`	string	Yes	No	Yes	Buyer address on one line: street, number, complement, neighborhood and ZIP code, comma-separated. Empty when no address was given.
`ownerId`	string (UUID)	Yes	No	No	Seller account ID.
`projectId`	string (UUID)	Yes	No	No	ID of the offer project.
`productId`	string (UUID)	Yes	No	No	Product ID.
`expiredDate`	string (ISO 8601)	Yes	No	No	Date and time Clickmax detected the expiration or due date.
`utmSource`	string	No	No	No	Visit `utm_source` parameter.
`utmMedium`	string	No	No	No	Visit `utm_medium` parameter.
`utmCampaign`	string	No	No	No	Visit `utm_campaign` parameter.
`utmTerm`	string	No	No	No	Visit `utm_term` parameter.
`utmContent`	string	No	No	No	Visit `utm_content` parameter.
`src`	string	No	No	No	Free `src` URL parameter, used by tools such as VTurb and UTMify to attribute the conversion.
`sck`	string	No	No	No	Free `sck` URL parameter, used to attribute the conversion.

Example body:

{
  "buyerId": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "leadId": "a01f1d8e-c418-4217-9d80-9b4a29438a52",
  "offerId": "d3429377-199d-4075-aa4c-9a32d327a877",
  "offerName": "Meu produto",
  "offerPrice": 9700,
  "offerType": "software",
  "buyerEmail": "buyer@email.com",
  "buyerName": "Buyer Name",
  "buyerDocument": "12345678909",
  "buyerTelephone": "5538933008932",
  "city": "São Paulo",
  "state": "SP",
  "country": "BR",
  "address": "Avenida Paulista, 1000, Sala 123, Bela Vista, 01310-100",
  "ownerId": "0b03581c-8f7e-4269-81a9-063f6e8ea6c0",
  "projectId": "a19950fa-f965-4415-84d8-73e102a9ab7e",
  "productId": "1fd8c3f0-8d15-4228-951f-f1d6c5df1015",
  "expiredDate": "2026-01-15T14:30:00.000Z",
  "utmSource": "source",
  "utmMedium": "medium",
  "utmCampaign": "campaign",
  "utmTerm": "term",
  "utmContent": "content",
  "src": "vturb_vsl_01",
  "sck": "lote2"
}

Tag added and tag removed

Triggers: TAG_ADDED, TAG_REMOVED.

The contact fields belong to the lead that got or lost the tag.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`id`	string (UUID)	Yes	No	No	Tag ID (not the lead ID).
`email`	string (e-mail)	No	Yes	No	Lead e-mail.
`name`	string	No	Yes	No	Lead name.
`telephone`	string	No	Yes	No	Lead phone.
`whatsappNumber`	string	No	Yes	No	Lead WhatsApp number.
`secondaryEmail`	string	No	Yes	No	Lead secondary e-mail.
`nameTag`	string	Yes	No	No	Tag name.
`colorTag`	string	Yes	No	No	Tag color as 6-character hex, without `#` (for example, `A821D8`).

Example body:

{
  "id": "cc37fec6-85c0-423b-b704-a80d195d7fe9",
  "email": "example@email.com",
  "name": "Buyer Name",
  "telephone": "5538933008932",
  "whatsappNumber": "5538933008932",
  "secondaryEmail": "example2@email.com",
  "nameTag": "Tag Name",
  "colorTag": "1b0570"
}

Funnel created and funnel deleted

Triggers: FUNNEL_CREATED, FUNNEL_DELETED.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`name`	string	Yes	No	No	Funnel name.
`description`	string	No	Yes	No	Funnel description.
`funnelUrl`	string	Yes	No	Yes	Funnel address, without `https://` (for example, `mydomain.com/f/my-funnel`). May be empty on a deletion caused by deleting the project, when the funnel has no custom domain.
`path`	string	Yes	No	No	Funnel path (slug).
`type`	string	No	Yes	No	Funnel model chosen at creation (for example, `vsl`, `webinar`, `leadMagnet`).
`category`	string (enum)	No	Yes	No	Funnel category. Possible values: `basic`, `premium`, `special`.

Example body:

{
  "name": "Funnel name",
  "description": "Funnel description",
  "funnelUrl": "new-project-5250.clickmax.localhost/funnel-name",
  "path": "funnel-name",
  "type": "sequentialSales",
  "category": "basic"
}

Funnel edited

Triggers: FUNNEL_EDITED.

Carries the whole funnel before (oldFields) and after (newFields) the edit. Only fires when one of these fields changed.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`oldFields`	object	No	No	—	Funnel before the edit.
`oldFields.name`	string	Yes	No	No	Before: Funnel name.
`oldFields.description`	string	No	Yes	No	Before: Funnel description.
`oldFields.funnelUrl`	string	Yes	No	Yes	Before: Funnel address, without `https://` (for example, `mydomain.com/f/my-funnel`). May be empty on a deletion caused by deleting the project, when the funnel has no custom domain.
`oldFields.path`	string	Yes	No	No	Before: Funnel path (slug).
`oldFields.type`	string	No	Yes	No	Before: Funnel model chosen at creation (for example, `vsl`, `webinar`, `leadMagnet`).
`oldFields.category`	string (enum)	No	Yes	No	Before: Funnel category. Possible values: `basic`, `premium`, `special`.
`newFields`	object	No	No	—	Funnel after the edit.
`newFields.name`	string	Yes	No	No	After: Funnel name.
`newFields.description`	string	No	Yes	No	After: Funnel description.
`newFields.funnelUrl`	string	Yes	No	Yes	After: Funnel address, without `https://` (for example, `mydomain.com/f/my-funnel`). May be empty on a deletion caused by deleting the project, when the funnel has no custom domain.
`newFields.path`	string	Yes	No	No	After: Funnel path (slug).
`newFields.type`	string	No	Yes	No	After: Funnel model chosen at creation (for example, `vsl`, `webinar`, `leadMagnet`).
`newFields.category`	string (enum)	No	Yes	No	After: Funnel category. Possible values: `basic`, `premium`, `special`.

Example body:

{
  "oldFields": {
    "name": "Old funnel name",
    "description": "Old funnel description",
    "funnelUrl": "new-project-5250.clickmax.localhost/old-funnel-name",
    "path": "old-funnel-name",
    "type": "sequentialSales",
    "category": "basic"
  },
  "newFields": {
    "name": "Funnel name",
    "description": "Funnel description",
    "funnelUrl": "new-project-5250.clickmax.localhost/funnel-name",
    "path": "funnel-name",
    "type": "sequentialSales",
    "category": "basic"
  }
}

Page deleted

Triggers: PAGE_DELETED.

Also fires for each page when the whole project is deleted.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`name`	string	Yes	No	No	Page name.
`slug`	string	Yes	No	No	Page path, starting with `/`.
`pageUrl`	string	No	No	No	Page address on the custom domain, without `https://`. Missing when the page does not use a custom domain.
`type`	string (enum)	No	No	No	Page type. Possible values: `advertorial`, `capture`, `quiz`, `presell`, `sales`, `checkout`, `upsell`, `downsell`, `termsPrivacy`, `thankYou`, `vsl`, `webinar`.

Example body:

{
  "name": "Page name",
  "slug": "page-slug",
  "pageUrl": "https://test.clickmax.io/page-slug",
  "type": "sales"
}

Project created and project deleted

Triggers: PROJECT_CREATED, PROJECT_DELETED.

Field	Type	Required	Accepts `null`	May be empty (`""`)	Description
`name`	string	Yes	No	No	Project name.

Example body:

{
  "name": "Project name"
}

Record statuses

Every delivery creates a record with one of these statuses.

Status	Meaning	Applies to
`PROCESSING`	Received/sent, being processed	inbound and outbound
`COMPLETED`	Processed successfully	inbound and outbound
`DELAYED`	Delivery postponed for a retry	outbound only
`FAILED`	Failed. For outbound, the automatic attempts are over; resend it from the integration history	inbound and outbound

If it didn't work

The platform gets a 401 when sending inbound: the webhook is inactive, has been deleted, or the token/signature does not match — see Error codes.
An outbound webhook never reaches its destination: check the record status and the endpoint's response in Error codes.
General questions about integrations: see the Frequently asked questions.

#Webhooks

#Direction

#Inbound platforms

#Outbound platforms

#Triggers

#Card declined vs transaction failed

#Purchase or renewal invoice in SALE_MADE

#When SUBSCRIPTION_CANCELLED fires

#Request format (outbound)

#Authentication

#How to tell which event arrived

#Response, retries and deactivation

#Platforms with their own format

#Body of each event

#Lead created and lead captured

#Sale made

#Sale cancelled, refund and chargeback

#Subscription started

#Subscription cancelled

#Abandoned cart

#Card refused

#Transaction failed

#Pix or boleto expired or overdue

#Tag added and tag removed

#Funnel created and funnel deleted

#Funnel edited

#Page deleted

#Project created and project deleted

#Record statuses

#Related

#If it didn't work

Webhooks

Direction

Inbound platforms

Outbound platforms

Triggers

Card declined vs transaction failed

Purchase or renewal invoice in `SALE_MADE`

When `SUBSCRIPTION_CANCELLED` fires

Request format (outbound)

Authentication

How to tell which event arrived

Response, retries and deactivation

Platforms with their own format

Body of each event

Lead created and lead captured

Sale made

Sale cancelled, refund and chargeback

Subscription started

Subscription cancelled

Abandoned cart

Card refused

Transaction failed

Pix or boleto expired or overdue

Tag added and tag removed

Funnel created and funnel deleted

Funnel edited

Page deleted

Project created and project deleted

Record statuses

Related

If it didn't work