Payload version 2
Payload version 2 is the body format of dashboard webhooks created with version 2, the default of the dashboard. It sends the event data ready to use, with names and e-mails, and people identified by numeric ID.
Payload version 3 sends the same data when the webhook is set to masked or full, and adds several events per URL, filters, replay, and public IDs. See Webhooks v3 reference and API webhooks.
The body
Every event is a POST with a JSON body: version, the event name in event, a unique event_id, and the data in payload:
{
"version": "2",
"event": "course.concluded",
"event_id": "01K5QW7M2Z3Y4X5W6V7U8T9S0R",
"payload": {
"user": { "id": 1042, "name": "Maria Souza", "email": "[email protected]" },
"product": { "id": 311, "name": "Curso de Fotografia" }
}
}The Diamond funnel events carry their data in data instead of payload. Each event and its fields are in the version 2 reference.
Deliveries, retries, and signatures work the same way for every version. See Deliveries and retries and Signatures.