oncall-engine/engine/apps/public_api/serializers
Michael Derynck b5a8b8b168
Add webhook presets (#2996)
# What this PR does
Add a system similar to how we select integrations when creating
webhooks so that the user has a description of what webhookds do and
does not have to write complex templates for common webhook use cases.
Presets allow us to create the contents of the webhooks in code and
define which fields are controlled by the preset. Some specifics:

- Newly created webhooks must choose between Simple, Advanced or another
predefined system
- Simple is always an escalation step and will post the entire payload
to the given URL
- Advanced is the same as no preset which is our current view where all
fields are available
- There are no changes for all existing webhooks with empty preset
fields
- Once a webhook is created with a preset the preset cannot be changed
- Fields in the webhook that are populated by code will give a
validation error if they are modified
- In the public API webhooks with presets are returned for viewing but
cannot be created or modified. This restriction is in place because the
Web UI provides the context for which fields to use with a preset. The
public API is for interacting with webhooks where all fields are
defined.

To define a preset create a file with metadata and an override function.
The metadata drives validation and what to display in the UI. There are
two functions one is connected to the pre_save hook of the Webhook model
for persistent changes, the other replaces parameters at execution time
for ephemeral changes. See the simple and advanced presets as an
example. The file must be listed in settings in
`INSTALLED_WEBHOOK_PRESETS` to be enabled at runtime..

## Which issue(s) this PR fixes

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)

---------

Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
2023-09-27 07:22:52 -06:00
..
__init__.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
action.py Fix public actions endpoint to handle empty user field (#3053) 2023-09-26 14:54:41 +00:00
alerts.py add several new database columns + emit two new Django signals (#1522) 2023-04-14 09:15:57 +02:00
escalation_chains.py Allow editing assigned team via public api (#1619) 2023-04-05 06:39:30 +00:00
escalation_policies.py Update escalation policies public API to handle new webhooks (#2999) 2023-09-11 10:50:18 -03:00
incidents.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
integrations.py Polish amv2 (#2701) 2023-08-01 13:13:58 +08:00
integtration_heartbeat.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
maintenance.py add mypy static type checker to backend codebase (#2151) 2023-06-12 12:50:33 -04:00
on_call_shifts.py shift swap requests model + CRUD endpoints (#2597) 2023-07-21 19:35:19 +00:00
organizations.py remove organization maintenance mode + fix integration maintenance mode (#2511) 2023-07-12 16:41:44 -04:00
personal_notification_rules.py Fix duplicate orders on routes and escalation policies (#2568) 2023-07-18 17:17:53 +00:00
resolution_notes.py remove references to AlertGroup.is_archived and AlertGroup.unarchived_objects (#2524) 2023-07-18 11:48:34 +00:00
routes.py Minor formatting changes (#2641) 2023-07-26 14:45:44 +01:00
schedules_base.py apps.get_model -> import (#2619) 2023-07-25 09:43:23 +00:00
schedules_calendar.py Add schedules enable_web_overrides option to public API (#3062) 2023-09-26 14:04:53 -03:00
schedules_ical.py Allow editing assigned team via public api (#1619) 2023-04-05 06:39:30 +00:00
schedules_polymorphic.py Initial web schedule model and serializers. Add override shift type. 2022-07-05 12:41:55 -03:00
schedules_web.py shift swap requests model + CRUD endpoints (#2597) 2023-07-21 19:35:19 +00:00
slack_channel.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
teams.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
user_groups.py World, meet OnCall! 2022-06-03 08:09:47 -06:00
users.py Add RBAC Support (#777) 2022-11-29 09:41:56 +01:00
webhooks.py Add webhook presets (#2996) 2023-09-27 07:22:52 -06:00