Aller au contenu principal

Webhooks

Vous avez la possibilité de vous abonner à des webhooks à partir de vos dossiers. Les webhooks permettent de recevoir une information suite à un événement se produisant à partir de votre compte URLR.

Événements disponibles

NomDescription
Lien cliquéÉvénement envoyé à chaque clic reçu par un lien du dossier

Format d'une requête

Requête POST sur votre URL configurée sur URLR.

Headers

HeaderDescriptionValeur d'exemple
dateDate d'envoiSun, 15 Oct 2023 19:28:47 GMT
user-agentUser-AgentURLR
x-signatureSignature pour vérifier le webhookfef82811b8c21eddf3202a50f069ada534bdb0263508b122d24a878d005dc26a
content-typeFormat du bodyapplication/json

Body

{
"event": "link_clicked",
"link": {
"code": "yBPhx",
"team": 5,
"folder": 10
},
"country": 'null',
"region": null,
"city": null,
"system": "GNU/Linux",
"browser": "Firefox",
"isBot": false,
"referer": null,
"timestamp": 1697398126
}

Sécurisation

Il est important de vous assurer que les webhooks que vous allez recevoir sont envoyés par URLR.

Pour cela, vous allez utiliser votre clé secrète que vous pouvez retrouver dans la configuration de vos webhooks et la valeur du champ x-signature dans les headers.

Le but est de générer une valeur de clé de hachage à partir du body, en utilisant la méthode HMAC, et de la comparer avec la signature reçue.

Avec PHP, vous pourriez par exemple vérifier la signature de cette façon :

<?php

function verifySignature(string $body, string $secretKey): bool {
$signature = $_SERVER['x-signature'];

$computedSignature = hash_hmac('sha256', $body, $secretKey);

return hash_equals($computedSignature, $signature);
}