> For the complete documentation index, see [llms.txt](https://docapi.cards-microlearning.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docapi.cards-microlearning.com/webhooks/details-des-evenements.md).

# Détails des évènements

Retrouvez ici la liste des évènements ainsi que les informations envoyées selon le type d'évènement.

### `chapter-complete`

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "chapter-complete",
    "created_at": "2024-01-20 09:10:00", // date de l'envoi au webhook
    "data": {
        "created_at": "2024-01-20 09:09:00", // date de l'action par le user
        "points": 1, // nb de points obtenus par le user sur l'action
        "user": {
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "lang": "fr"
        },
        "training": {
            "id": "xxxx",
            "title": "Titre de ma formation",
            "description": "Description de ma formation",
            "image": "https://api.cards-microlearning.com/xxxx",
            "chapters_count": 5, // nb de chapitres dans la formation
            "chapter": {
                "id": "xxxx"
                "title": "Titre de mon chapitre",
                "position": 1 // position du chapitre dans la formation
            }
        },
        "score": {
            "points": 1,
            "max_points": 1,
            "progress": 0.2
        }
    }
}
```

### `quiz-complete`

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "quiz-complete",
    "created_at": "2024-01-20 09:10:00", // date de l'envoi au webhook
    "data": {
        "created_at": "2024-01-20 09:09:00", // date de l'action par le user
        "points": 1, // nb de points obtenus par le user sur l'action
        "user": {
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "lang": "fr"
        },
        "training": {
            "id": "xxxx",
            "title": "Titre de ma formation",
            "description": "Description de ma formation",
            "image": "https://api.cards-microlearning.com/xxxx",
            "chapters_count": 5, // nb de chapitres dans la formation
            "chapter": {
                "id": "xxxx"
                "title": "Titre de mon chapitre",
                "position": 1, // position du chapitre dans la formation
                "card": {
                    "id": "xxxx",
                    "type": "quiz", // (quiz ou quiz-order)
                    "content": "Question du quiz",
                    "answers": [ // réponses possibles au quiz et réponses de l'apprenant
                        {
                            "id": "xxxx",
                            "content": "Réponse A", 
                            "position": 1,
                            "is_correct": 1,
                            "points": 2,
                            "selected": true
                        },
                        {
                            "id": "xxxx",
                            "content": "Réponse B",
                            "position": 2,
                            "is_correct": 1,
                            "points": 2,
                            "selected": true
                        },
                        {
                            "id": "xxxx",
                            "content": "Réponse C",
                            "position": 3,
                            "is_correct": 0,
                            "points": -1,
                            "selected": false
                        }
                    ]
                }
            }
        },
        "score": {
            "points": 4,
            "max_points": 4,
            "progress": 0.2
        }
    }
}
```

### `survey-complete`

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "survey-complete",
    "created_at": "2024-01-20 09:10:00", // date de l'envoi au webhook
    "data": {
        "created_at": "2024-01-20 09:09:00", // date de l'action par le user
        "points": 1, // nb de points obtenus par le user sur l'action
        "user": {
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "lang": "fr"
        },
        "training": {
            "id": "xxxx",
            "title": "Titre de ma formation",
            "description": "Description de ma formation",
            "image": "https://api.cards-microlearning.com/xxxx",
            "chapters_count": 5, // nb de chapitres dans la formation
            "chapter": {
                "id": "xxxx"
                "title": "Titre de mon chapitre",
                "position": 1, // position du chapitre dans la formation
                "card": {
                    "id": "xxxx",
                    "type": "survey",
                    "content": "Question du sondage",
                    "answers": [ // réponses possibles au sondage et réponses de l'apprenant
                        {
                            "id": "xxxx",
                            "content": "Réponse A", 
                            "position": 1,
                            "is_correct": 1,
                            "points": 0,
                            "selected": true
                        },
                        {
                            "id": "xxxx",
                            "content": "Réponse B",
                            "position": 2,
                            "is_correct": 1,
                            "points": 0,
                            "selected": true
                        },
                        {
                            "id": "xxxx",
                            "content": "Réponse C",
                            "position": 3,
                            "is_correct": 1,
                            "points": 0,
                            "selected": false
                        }
                    ]
                }
            }
        },
        "score": {
            "points": 0,
            "max_points": 0,
            "progress": 0.2
        }
    }
}
```

### `training-complete`

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "training-complete",
    "created_at": "2024-01-20 09:10:00", // date de l'envoi au webhook
    "data": {
        "created_at": "2024-01-20 09:09:00", // date de l'action par le user
        "points": 1, // nb de points obtenus par le user sur l'action
        "user": {
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "lang": "fr"
        },
        "training": {
            "id": "xxxx",
            "title": "Titre de ma formation",
            "description": "Description de ma formation",
            "image": "https://api.cards-microlearning.com/xxxx",
            "chapters_count": 5 // nb de chapitres dans la formation
        },
        "score": {
            "points": 6,
            "max_points": 6,
            "progress": 1
        }
    }
}
```

### routine-complete

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "routine-complete",
    "created_at": "2024-01-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "created_at": "2024-01-21 09:09:00", // date de l'action par le user
        "user": {
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "lang": "fr"
        },
        "routine": {
            "id": "xxxx",
            "title": "Titre de la routine",
            "description": "Description de la routine",
            "type": "progress", // type de routine
            "date_start": null, // si date de début définie
            "date_end": null, // si date de fin définie
            "steps_count": 5 // nb d'étapes
        },
        "score": {
            "points": 10,
            "max_points": 10,
            "progress": 1
        }
    }
}
```

### user-created & user-deleted

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "user-created", // ou "user-deleted"
    "created_at": "2024-01-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "user": {
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "lang": "fr"
        }
    }
}
```

### user-updated

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "user-updated",
    "created_at": "2024-01-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "user_before": {
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "phone": "0000",
            "lang": "fr"
        },
        "user_after": {
            "id": "xxxx",
            "firstname": "Johnny",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "Y",
            "phone": "0000",
            "lang": "fr"
        }
    }
}
```

### user-group-added & user-group-removed

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "user-group-added", // ou "user-group-removed"
    "created_at": "2024-01-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "user": { // user added or removed from group
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "lang": "fr"
        },
        "group": { // group where user was added or removed
            "id": "xxxx",
            "name": "group's name"
        }
    }
}
```

### group-created & group-deleted

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "group-created", // ou "group-deleted"
    "created_at": "2024-01-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "group": {
            "id": "xxxx",
            "name": "group's name"
        }
    }
}
```

### group-updated

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "group-updated",
    "created_at": "2024-01-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "group_before": {
            "id": "xxxx",
            "name": "group's name"
        },
        "group_after": {
            "id": "xxxx",
            "name": "new group's name"
        }
    }
}
```

### badge-created & badge-deleted

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "badge-created", // ou "badge-deleted"
    "created_at": "2024-10-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "badge": {
            "id": "xxxx",
            "name": "badge's name",
            "description": "xxxx",
            "imageurl": "https://api.cards-microlearning.com/...",
            "emoji": [],
            "status": "publish" // ou 'draft' / 'expire'
        }
    }
}
```

### badge-updated

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "badge-updated",
    "created_at": "2024-10-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "badge_before": {
            "id": "xxxx",
            "name": "badge's name",
            "description": "xxxx",
            "imageurl": "https://api.cards-microlearning.com/...",
            "emoji": [],
            "status": "draft" // ou 'publish' / 'expire'
        },
        "badge_after": {
            "id": "xxxx",
            "name": "badge's name",
            "description": "xxxx",
            "imageurl": null,
            "emoji": {
                "n": [
                    0: "thinking face",
                    1: "thinking_face"
                ],
                "u": "1f914",
                "r": "1f914",
                "t": "neutral",
                "i": "🤔",             
           },
           "status": "publish" // ou 'draft' / 'expire'
        },
    }
}
```

### badge-unlocked

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "badge-unlocked",
    "created_at": "2024-10-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "badge": {
            "id": "xxxx",
            "name": "badge's name",
            "description": "xxxx",
            "imageurl": "https://api.cards-microlearning.com/...",
            "emoji": []
        },
        "user": {
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "lang": "fr"
        }        
    }
}
```

### certificate-created & certificate-deleted

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "certificate-created", // ou "certificate-deleted"
    "created_at": "2024-10-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "badge": {
            "id": "xxxx",
            "name": "certificate's name",
            "description": "xxxx",
            "content": "xxxx",
            "status": "publish" // ou 'draft' / 'expire'
        }
    }
}
```

### certificate-updated

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "certificate-updated",
    "created_at": "2024-10-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "certificate_before": {
            "id": "xxxx",
            "name": "certificate's name",
            "description": "xxxx",
            "content": "xxxx",
            "status": "draft" // ou 'publish' / 'expire'
        },
        "certificate_after": {
            "id": "xxxx",
            "name": "certificate's name",
            "description": "xxxx",
            "content": "xxxx",
            "status": "publish" // ou 'draft' / 'expire'
        },
    }
}
```

### certificate-unlocked

```json
{
    "id": "xxxx" // id unique de l'event
    "type": "certificate-unlocked",
    "created_at": "2024-10-21 09:10:00", // date de l'envoi au webhook
    "data": {
        "certificate": {
            "id": "xxxx",
            "name": "certificate's name",
            "description": "xxxx",
            "content": "xxxx"
        },
        "user": {
            "id": "xxxx",
            "firstname": "John",
            "lastname": "Doe",
            "email": "john.doe@example.com",
            "company": "X",
            "lang": "fr"
        }        
    }
}
```