diff --git a/docs/api/native-app-integration/sending-data.md b/docs/api/native-app-integration/sending-data.md index 02f89506..4fcc1f52 100644 --- a/docs/api/native-app-integration/sending-data.md +++ b/docs/api/native-app-integration/sending-data.md @@ -142,7 +142,7 @@ Call a service in Home Assistant. ## Fire an event -Fire an event in Home Assistant. +Fire an event in Home Assistant. Please be mindful of the data structure as documented on our [Data Science portal](https://data.home-assistant.io/docs/events/#database-table). ```json { diff --git a/docs/api/rest.md b/docs/api/rest.md index 14d95f1b..0e84b023 100644 --- a/docs/api/rest.md +++ b/docs/api/rest.md @@ -499,7 +499,7 @@ curl -X POST -H "Authorization: Bearer ABCDEFGH" \ #### POST /api/events/<event_type> -Fires an event with event_type +Fires an event with event_type. Please be mindful of the data structure as documented on our [Data Science portal](https://data.home-assistant.io/docs/events/#database-table). You can pass an optional JSON object to be used as `event_data`. diff --git a/docs/creating_component_code_review.md b/docs/creating_component_code_review.md index 6de019a6..ea5e68b9 100644 --- a/docs/creating_component_code_review.md +++ b/docs/creating_component_code_review.md @@ -63,7 +63,7 @@ Keep a new integration to the minimum functionality needed for someone to get va ### 6. Event names -Prefix component event names with the domain name. For example, use `netatmo_person` instead of `person` for the `netatmo` component. +Prefix component event names with the domain name. For example, use `netatmo_person` instead of `person` for the `netatmo` component. Please be mindful of the data structure as documented on our [Data Science portal](https://data.home-assistant.io/docs/events/#database-table). ### 7. Tests diff --git a/docs/dev_101_events.md b/docs/dev_101_events.md index afffae4a..e0e75d23 100644 --- a/docs/dev_101_events.md +++ b/docs/dev_101_events.md @@ -10,7 +10,7 @@ The event system is very flexible. There are no limitations on the event type, a ## Firing events -To fire an event, you have to interact with the event bus. The event bus is available on the Home Assistant instance as `hass.bus`. +To fire an event, you have to interact with the event bus. The event bus is available on the Home Assistant instance as `hass.bus`. Please be mindful of the data structure as documented on our [Data Science portal](https://data.home-assistant.io/docs/events/#database-table). Example component that will fire an event when loaded. Note that custom event names are prefixed with the component name.