django-helpdeskmig/docs/webhooks.rst
2023-12-02 20:57:21 +00:00

11 lines
722 B
ReStructuredText

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.