From 34a26ff5d1c2e5b6d6a439782639de6d05192d79 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Mon, 9 Dec 2024 13:23:15 +0100 Subject: [PATCH] docs: add note about custom serializer in step 5 --- docs/how-tos/adding-event-bus-support-to-an-event.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/how-tos/adding-event-bus-support-to-an-event.rst b/docs/how-tos/adding-event-bus-support-to-an-event.rst index 3b399ae5..acb9a88b 100644 --- a/docs/how-tos/adding-event-bus-support-to-an-event.rst +++ b/docs/how-tos/adding-event-bus-support-to-an-event.rst @@ -144,6 +144,8 @@ Step 5: Send the Event Across Services with the Event Bus To validate that you can consume the event emitted by a service through the event bus, you can send the event across services. Here is an example of how you can send the event across services using the Redis event bus implementation following the `setup instructions in a Tutor environment`_. +.. note:: If you implemented a custom serializer for a type in the :term:`Event Payload`, the custom serializer support must be included in both the producer and consumer sides before it can be used. + .. _Avro: https://avro.apache.org/ .. _OpenEdxPublicSignal: https://github.com/openedx/openedx-events/blob/main/openedx_events/tooling.py#L37 .. _attrs data classes: https://www.attrs.org/en/stable/overview.html