Add section in documentation about dm_event_fields parameter
authorHarmon <Harmon758@gmail.com>
Tue, 15 Nov 2022 04:18:39 +0000 (22:18 -0600)
committerHarmon <Harmon758@gmail.com>
Tue, 15 Nov 2022 04:18:39 +0000 (22:18 -0600)
docs/expansions_and_fields.rst

index 63041a56528a021bb206d3d4a75a2ef58881bad5..6c38e1671e7864226ddcd8d6d7298359823e86ff 100644 (file)
@@ -147,6 +147,15 @@ References
 ^^^^^^^^^^
 https://developer.twitter.com/en/docs/twitter-api/expansions
 
+.. _dm_event_fields_parameter:
+
+``dm_event_fields``
+-------------------
+
+Extra fields to include in the event payload. ``id`` and ``event_type`` are
+returned by default. The ``text`` value isn't included for ``ParticipantsJoin``
+and ``ParticipantsLeave`` events.
+
 .. _list_fields_parameter:
 
 ``list_fields``