NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-09 09:08:15 -06:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

#2347 - Expand Webhook Documentation

Browse Source 
Add text for installation to link to other documentation sections with instructions.
This commit is contained in:
mmahacek 2018-10-16 10:00:40 -07:00 committed by GitHub
parent 28ed57cae4
commit 2477f5ccfc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/additional-features/webhooks.md
View File

@ -4,6 +4,14 @@ A webhook defines an HTTP request that is sent to an external application when c
An optional secret key can be configured for each webhook. This will append a `X-Hook-Signature` header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key. This digest can be used by the receiver to authenticate the request's content. An optional secret key can be configured for each webhook. This will append a `X-Hook-Signature` header to the request, consisting of a HMAC (SHA-512) hex digest of the request body using the secret as the key. This digest can be used by the receiver to authenticate the request's content.
## Installation
If you are upgrading from a previous version of Netbox and want to enable the webhook feature, please follow the directions listed in the sections below.
* [Install Redis server and djano-rq package](../installation/2-netbox/#install-python-packages)
* [Modify configuration to enable webhooks](../installation/2-netbox/#webhooks-configuration)
* [Create supervisord program to run the rqworker process](../installation/3-http-daemon/#supervisord-installation)
## Requests ## Requests
The webhook POST request is structured as so (assuming `application/json` as the Content-Type): The webhook POST request is structured as so (assuming `application/json` as the Content-Type):