Implement webhooks. Fixes #264

This commit is contained in:
Timothy Hobbs
2023-12-02 18:09:34 +00:00
parent 5e1fb838cb
commit e708281dcd
10 changed files with 294 additions and 7 deletions

View File

@ -1,9 +1,3 @@
Integrating django-helpdesk into your application
=================================================
Ticket submission with embeded iframe
-------------------------------------
Ticket submission with embeded iframe
-------------------------------------

View File

@ -17,7 +17,8 @@ Contents
spam
custom_fields
api
integration
webhooks
iframe_submission
teams
license

10
docs/webhooks.rst Normal file
View File

@ -0,0 +1,10 @@
Registering webhooks to be notified of helpesk events
-----------------------------------------------------
You can register webhooks to allow third party apps to be notified of helpdesk events. Webhooks can be registered in one of two ways:
1. Setting comma separated environement variables; ``HELPDESK_NEW_TICKET_WEBHOOK_URLS``& ``HELPDESK_FOLLOWUP_WEBHOOK_URLS``.
2. Adding getter functions to your ``settings.py``. These should return a list of strings (urls); ``HELPDESK_GET_NEW_TICKET_WEBHOOK_URLS`` & ``HELPDESK_GET_FOLLOWUP_WEBHOOK_URLS``.
Once these URLs are configured, a serialized copy of the ticket object will be posted to each of these URLs each time a ticket is created or followed up on respectively.