Chaque application cliente OAuth2 a la possibilité de recevoir des informations de la part de Phraseanet par l’intermédiaire des Webhooks. Il s’agit d’envoyer une requête HTTP avec le verbe POST vers une URL donnée quand un évènement se produit. Ces Webhooks peuvent être utilisés pour effectuer des actions particulières comme l’envois d’e-mails, l’exécution de mises à jours, la notification de nouveaux flux. Cela permet fin d’étendre les fonctionnalités de l’application cliente.
Un Webhook peut être configuré pour déclencher un ou plusieurs événements. L’application cliente doit prendre en charge l’écoute d’événements à déclencher.
Note
Pour l’instant Phraseanet ne déclenche de Webhooks que lorsqu’une nouvelle entrée est créée dans un flux RSS. Il n’est pas possible dans la version courante de configurer le type d’événement à déclencher. Cependant cette éventualité est envisagé dans les versions à venir.
Un seul événement disponible
| Name | Description |
|---|---|
| new_feed_entry | Une nouvelle entrée d’un flux RSS est créée. |
Les données envoyées pour chaque événement sont au format JSON. Chaque événement possède un schéma JSON avec pour une clé “name” pour représenter le type d’évènement.
Exemple d’objet JSON envoyé par Phraseanet.
{
"name" : ":event_name",
...
}
Seules les données utiles diffèrent.
Liste des objets de données utiles par évènement
{
"name": "new_feed_entry",
"users_were_notified": false,
"feed": {
"title": "Cannes Festival",
"description": "Your everyday news about cannes festival",
"is_public": false
},
"entry": {
"author": {
"name": "nicolas@fdc.fr",
"email": "nicolas@fdc.fr"
},
"title": "PRESS CONFERENCE - Winners",
"description": "At the end of the Closing Ceremony, the winners have come, each in turn, speak to the press."
},
"users": [
{
"mail": "bradley72@yahoo.com",
"firstname": "John",
"lastname": "Bradley"
},
{
"mail": "king.benett@movie-news.org",
"firstname": "Johnatan",
"lastname": "Benett"
}
]
}