mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Enable custom templating for webhook request content

Browse Source
This commit is contained in:
Jeremy Stretch
2020-02-24 16:12:46 -05:00
parent 81d001d49e
commit 99038ffc44
7 changed files with 87 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
netbox/extras/webhooks_worker.py
View File

@ -1,19 +1,25 @@
import json
import logging
import requests
from django_rq import job
from jinja2.exceptions import TemplateError
from rest_framework.utils.encoders import JSONEncoder
from .choices import ObjectChangeActionChoices, WebhookContentTypeChoices
from utilities.utils import render_jinja2
from .choices import ObjectChangeActionChoices
from .constants import HTTP_CONTENT_TYPE_JSON
from .webhooks import generate_signature
logger = logging.getLogger('netbox.webhooks_worker')
@job('default')
def process_webhook(webhook, data, model_name, event, timestamp, username, request_id):
"""
Make a POST request to the defined Webhook
"""
payload = {
context = {
'event': dict(ObjectChangeActionChoices)[event].lower(),
'timestamp': timestamp,
'model': model_name,
@ -21,6 +27,8 @@ def process_webhook(webhook, data, model_name, event, timestamp, username, reque
'request_id': request_id,
'data': data
}
# Build HTTP headers
headers = {
'Content-Type': webhook.http_content_type,
}
@ -33,10 +41,22 @@ def process_webhook(webhook, data, model_name, event, timestamp, username, reque
'headers': headers
}
if webhook.http_content_type == WebhookContentTypeChoices.CONTENTTYPE_JSON:
params.update({'data': json.dumps(payload, cls=JSONEncoder)})
elif webhook.http_content_type == WebhookContentTypeChoices.CONTENTTYPE_FORMDATA:
params.update({'data': payload})
logger.info(
"Sending webhook to {}: {} {}".format(params['url'], context['model'], context['event'])
)
# Construct the request body. If a template has been defined, use it. Otherwise, dump the context as either JSON
# or form data.
if webhook.body_template:
try:
params['data'] = render_jinja2(webhook.body_template, context)
except TemplateError as e:
logger.error("Error rendering request body: {}".format(e))
return
elif webhook.http_content_type == HTTP_CONTENT_TYPE_JSON:
params['data'] = json.dumps(context, cls=JSONEncoder)
else:
params['data'] = context
prepared_request = requests.Request(**params).prepare()
@ -50,9 +70,13 @@ def process_webhook(webhook, data, model_name, event, timestamp, username, reque
session.verify = webhook.ca_file_path
response = session.send(prepared_request)
logger.debug(params)
if 200 <= response.status_code <= 299:
logger.info("Request succeeded; response status {}".format(response.status_code))
return 'Status {} returned, webhook successfully processed.'.format(response.status_code)
else:
logger.error("Request failed; response status {}: {}".format(response.status_code, response.content))
raise requests.exceptions.RequestException(
"Status {} returned with content '{}', webhook FAILED to process.".format(
response.status_code, response.content