Skip to content

Commit

Permalink
docs: add note about custom serializer in step 5
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Dec 9, 2024
1 parent 856f582 commit 34a26ff
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/how-tos/adding-event-bus-support-to-an-event.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 34a26ff

Please sign in to comment.