From 189d4fdabeb85e5eedcb08d8d4c347e023c10e6e Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Tue, 21 Dec 2021 15:29:37 -0500 Subject: [PATCH] build_queued: document in the notifications docs --- doc/manual/src/notifications.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/manual/src/notifications.md b/doc/manual/src/notifications.md index b8f24580..94070771 100644 --- a/doc/manual/src/notifications.md +++ b/doc/manual/src/notifications.md @@ -8,6 +8,12 @@ Notifications are passed from `hydra-queue-runner` to `hydra-notify` through Pos Note that the notification format is subject to change and should not be considered an API. Integrate with `hydra-notify` instead of listening directly. +### `build_queued` + +* **Payload:** Exactly one value, the ID of the build. +* **When:** Issued after the transaction inserting the build in to the database is committed. One notification is sent per new build. +* **Delivery Semantics:** Ephemeral. `hydra-notify` must be running to react to this event. No record of this event is stored. + ### `build_started` * **Payload:** Exactly one value, the ID of the build.