Payload version 1

Payload version 1 is the older body format of dashboard webhooks. It carries the same data as version 2, with the event name in Portuguese and a different envelope.

Warning

Payload version 1 is deprecated and receives fixes only. New webhooks use payload version 2, the default. You can switch a webhook to version 2 in the dashboard, at Settings > Integrations > Webhooks.

The body

Every event is a POST with a JSON body: event_id, event_type with the event name, and the data in event:

{
  "event_id": "01K5QW7M2Z3Y4X5W6V7U8T9S0R",
  "event_type": "curso.concluido",
  "event": {
    "usuario": { "id": 1042, "nome": "Maria Souza", "email": "[email protected]" },
    "produto": { "id": 311, "nome": "Curso de Fotografia" }
  }
}

The Diamond funnel events have the same body in both versions. Each event and its fields are in the version 1 reference.

Moving to version 2

Version 1Version 2
Event nameevent_type, in Portuguese (curso.concluido)event, in English (course.concluded)
Dataeventpayload
Version markernoneversion: "2"

Deliveries, retries, and signatures work the same way for both versions. See Deliveries and retries and Signatures.

On this page