Introduction
L'API TrackTik et son architecture nuagique ont été conçus pour que vous puissiez récupérer vous-même de l'information en tant que solution d'intégration développée, modifier des données existantes ou créer de nouvelles données. Mais il peut également transmettre des données à un système tiers dans le cadre d'une intégration basée sur des déclencheurs et des actions en temps réel. Le service qui permet cela s'appelle : Abonnements aux événements.
Un abonnement à des événements est un service d'appel que vous créez et configurez vous-même. Une configuration standard se compose généralement des éléments suivants :
- Entité de données/point de terminaison - OBLIGATOIRE
- Déclencheur (création, mise à jour, action API) - OBLIGATOIRE
- Filtres (comme les paramètres =, :not, :in des appels GET de l'API) - FACULTATIF
- Liste d'inclusions (listes de relations, champs sur demande) - FACULTATIF
- Contexte régional (toutes les régions ou une partie d'un arbre régional) - OBLIGATOIRE
- Accès et autorisation au webhook (URL, nom de l'en-tête secret, secret, courriel pour les notifications d'erreurs) - OBLIGATOIRE
Configuration de base
La configuration la plus élémentaire est celle présentée ci-dessous, qui est un exemple d'abonnement envoyant de l'information sur les nouveaux employés à un système tiers — disons un système de ressources humaines — lorsqu'ils sont créés :
[POST] /events-subscriptions
{
"customId" : "customId of your choosing like ABC-123",
"name" : "A bit more descriptive text about the purpouse of this subscription",
"events" : [
"entity:employees:created"
],
"contextFilters": {
"filters": [
{
"tag": "context.region.3",
"includeChildren": true
}
]
},
"url" : "https://your.webhook.url/path/path",
"secretHeaderName" : "TrackTik-subscription-secret-without-spaces",
"secret" : "B2C60113ECB7 etc.",
"failureEmail" : "(optional) An email address you'd like to monitor errors at"
}
Cet abonnement fonctionnera de la manière suivante :
- Pour l'entité de données "employees"
- Déclenché par l'événement "created"
- Et seulement pour les employés qui appartiennent à une région de l'arbre dont le nœud supérieur a pour identifiant 3.
- Obtenir la même réponse JSON que lorsqu'on effectue un [GET] /employees
- Et envoyer la réponse JSON à l'url https://your.webhook.url/path/path
- Avec les paramètres d'en-tête d'authentification secretHeaderName, et secret
- Et en cas d'erreur, communiquez cette erreur à l'adresse de courriel failureEmail
- The language parameter isn't being defined, so it will default to EN-US
Fonctionnalités
En plus de pouvoir définir le quand et le quoi d'un appel, vous pourrez également travailler avec le point de terminaison /events-subscriptions pour voir l'état, les journaux et plus encore.
Pour en savoir davantage, voir notre documentation technique plus détaillée.