HappenBoard publie tous vos événements à venir sous forme de flux iCal : une adresse web que l’on ajoute à Google Agenda, Apple Calendrier ou Outlook. L’agenda affiche alors vos événements et récupère seul vos modifications.
Le flux est toujours actif. Il n’y a rien à activer.
Trouver l’adresse de votre flux
Votre flux se trouve à cette adresse, sur votre propre nom de domaine :
https://example.com/wp-json/happenboard/v1/ical/feed.ics
Remplacez example.com par votre domaine. Si votre site utilise les permaliens simples (des adresses comme ?p=123), utilisez plutôt https://example.com/?rest_route=/happenboard/v1/ical/feed.ics.
Ouverte dans un navigateur, l’adresse affiche ou télécharge un fichier texte. C’est normal : ce fichier est fait pour les applications d’agenda.
La proposer à vos visiteurs
Ajoutez l’adresse sous forme de lien sur une page, par exemple sur votre page d’événements ou dans le pied de page, avec un texte comme « Abonnez-vous à notre agenda ».
Certaines applications n’ouvrent leur fenêtre d’abonnement qu’avec une adresse en webcal://. Remplacez alors https:// par webcal:// au début de la même adresse.
Pour ajouter un seul événement, vos visiteurs utilisent plutôt le bloc Ajouter au calendrier de la page de l’événement. Son bouton .ics file télécharge cet événement seul, pas le flux.
S’abonner dans une application d’agenda
Les libellés changent selon les versions, mais il s’agit toujours d’ajouter un agenda à partir d’une adresse web :
- Google Agenda : à côté de Autres agendas, cliquez sur +, puis sur À partir de l’URL, et collez l’adresse ;
- Apple Calendrier : choisissez Fichier → Nouvel abonnement à un calendrier, puis collez l’adresse ;
- Outlook : choisissez Ajouter un calendrier, puis S’abonner à partir du web, et collez l’adresse.
C’est l’application d’agenda qui décide à quelle fréquence elle vérifie les changements. Google Agenda peut mettre plusieurs heures, et votre site ne peut pas l’accélérer.
Ce que contient le flux
- Uniquement les événements publiés. Les brouillons, les événements en attente et les événements privés sont exclus.
- Les dates qui ne sont pas encore terminées. Une date en cours reste dans le flux jusqu’à sa fin.
- Chaque date d’un événement récurrent, comme une entrée à part : un cours hebdomadaire apparaît une fois par semaine. Les dates annulées sont exclues.
Chaque entrée comporte le titre, le début et la fin, un lien vers la page de l’événement, l’extrait comme description, le nom et l’adresse du lieu, et les catégories. Les événements sur la journée entière restent sur le bon jour, quel que soit le fuseau horaire de l’abonné.
Un événement protégé par mot de passe apparaît avec son titre, ses dates, son lieu et son lien, mais jamais avec sa description.
Choisir jusqu’où il va
Le flux couvre les 12 prochains mois. Ajoutez months à l’adresse pour changer cette durée :
https://example.com/wp-json/happenboard/v1/ical/feed.ics?months=24
Vous pouvez demander de 1 à 60 mois. Un nombre plus grand est ramené à 60. Un flux contient au plus 5 000 dates : si vous avez beaucoup d’événements récurrents, raccourcissez la durée plutôt que de l’allonger.
Sites multilingues
Avec WPML ou Polylang, le flux liste les événements d’une seule langue : votre langue par défaut. Avec Polylang, ajoutez lang à l’adresse pour obtenir une autre langue, par exemple ?lang=fr pour le français. Pour combiner les deux réglages, écrivez ?months=24&lang=fr. Voir sites multilingues.
Délai de prise en compte des modifications
Votre site garde une copie toute prête du flux pendant une heure au plus. Il en refait une dès que vous modifiez un événement, un lieu, une catégorie ou l’adresse de vos événements. Les applications d’agenda peuvent réutiliser leur copie pendant cinq minutes.
Au-delà, le délai dépend du rythme propre à l’application d’agenda.
Le flux est public
L’adresse n’a pas de mot de passe et ne demande pas de connexion, car les services d’agenda doivent pouvoir la lire pour leurs utilisateurs. Toute personne qui a l’adresse peut la lire. Elle ne contient que ce que vos pages d’événement publiques montrent déjà.
Le flux ne va que dans un sens, de votre site vers les agendas. Pour faire entrer des événements dans votre site, voir importer un fichier .ics.
Pour aller plus loin
- Le bloc Ajouter au calendrier : permettre aux visiteurs d’enregistrer un seul événement.
- Importer un fichier .ics : faire entrer les événements d’un autre agenda dans HappenBoard.
- Synchroniser avec Google Calendar : une synchronisation dans les deux sens avec Pro.
- Sites multilingues : un flux par langue.