Checklist for integrations
Important information we need in order to implement your integration quickly and clearly.
Checklist for API connection
| Section | Question / Information | Input by Customer |
|---|---|---|
| 1. General Information | Name of the HR system | |
| Technical contacts (name, email, role) | ||
| Desired go-live date | ||
| Test environment available? (Yes/No + access) | ||
| Production endpoint available? | ||
| Existing integrations | ||
| 2. Authentication & Security | API key / OAuth credentials (test + live) – for data protection reasons, please provide encrypted transfer | |
| Endpoint for sending back completion/certificate data | ||
| 3. User Synchronization | User master data: first name, last name, email | |
| Additional custom fields? e.g., employee ID | ||
| TAG mapping (e.g., Department = TAG) | ||
| 3.2 User Status | User creation rule (when should a user be created?) | |
| Deactivation / offboarding logic | ||
| Handling of email changes | ||
| 3.3 Synchronization Frequency | Synchronization interval, e.g., once per day | |
| 4. Course / Learning Data (optional) | Should course data be transferred? (Yes/No) | |
| Description of where (which field) this information should be added and to what extent | ||
| 5. Certificate Feedback | Which data should be transferred back to the HR system? e.g., certificate name, completion date, etc. | |
| Certificate as file or link | ||
| Where in the system should the certificate be stored? | ||
| 6. Documentation | HR API documentation provided to us? | |
| Mapping document | ||
| Process flow diagram / sketch of connections (e.g., uni- or bidirectional) |