From 414e87d40b5eb3c3a81e1a553df77a1e3317bda0 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Apr 18 2016 09:57:18 +0000 Subject: Start documentating the specific headers sent with the POST request --- diff --git a/doc/using_webhooks.rst b/doc/using_webhooks.rst index a31dd48..72275fd 100644 --- a/doc/using_webhooks.rst +++ b/doc/using_webhooks.rst @@ -11,3 +11,18 @@ enter the URL to the server that will receive the notifications. In the settings page is also present a web-hook key which is used by the server to sign the message sent and which you can use to ensure the notifications received are coming from the right source. + +Each POST request made contains two specific headers: + +:: + + X-Pagure-Topic + X-Pagure-Signature + + +``X-Pagure-Topic`` is a global header giving a clue about the type of action +that just occured. For example ``issue.edit``. + + +``X-Pagure-Signature`` contains the signature of the message allowing to +check that the message comes from pagure.