holm/django-helpdeskmig
1
0
Fork 0
mirror of https://gitea.mueller.network/extern/django-helpdesk.git synced 2024-11-22 07:53:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update webhooks documentation

Browse Source
This commit is contained in:
Sam Splunks 2024-04-17 14:24:15 +02:00 committed by GitHub
parent 2f26180451
commit 16bb4d46f1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/webhooks.rst
View File

@ -12,18 +12,18 @@ You can register webhooks to allow third party apps to be notified of helpdesk e
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. 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.
Django signals Signals
-------------- --------------
Webhooks are triggered through signals emitted for new tickets creation and ticket follow-up updates. Webhooks are triggered through django signals.
The two existing signals are: The two existing signals are:
- new_ticket_done - new_ticket_done
- update_ticket_done - update_ticket_done
You have the opportunity to listen to those in your project if you have post processing workflows outside of webhooks. You have the opportunity to listen to those in your project if you have post processing workflows outside of webhooks::
```
from helpdesk.signals import new_ticket_done, update_ticket_done from helpdesk.signals import new_ticket_done, update_ticket_done
@receiver(new_ticket_done) @receiver(new_ticket_done)
@ -35,4 +35,3 @@ def process_new_ticket(sender, ticket, **kwargs):
def process_followup_update(sender, followup, **kwargs): def process_followup_update(sender, followup, **kwargs):
"Triggers this code when a follow-up is created." "Triggers this code when a follow-up is created."
pass pass
```