Skip to content

Commit 69671b1

Browse files
klardotshalexmv
authored andcommitted
docs: Document a bot-specific note about which email address to use.
1 parent 85e01b5 commit 69671b1

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

send-message/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This action sends a message to [Zulip](https://zulip.com/).
88
| ------------------ | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
99
| `api-key` | Yes | [API key](https://zulip.com/api/api-keys) used to interact with the Zulip API. You can get an API key through Zulip's web interface. You should store the API key [as a secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository). |
1010
| `content` | Yes | The content of the message, formatted using [Zulip Markdown](https://zulip.com/help/format-your-message-using-markdown). Maximum message size of 10000 bytes. |
11-
| `email` | Yes | Email address of the user who owns the API key mentioned above. |
11+
| `email` | Yes | Email address of the user who owns the API key mentioned above. If using a bot, this should be the bot's email address, not the owning user's! |
1212
| `organization-url` | Yes | Zulip organization canonical URL. |
1313
| `to` | Yes | For stream messages, either the name or integer ID of the stream. For private messages, either a list containing integer user IDs or a list containing string email addresses. |
1414
| `topic` | No | The topic of the message. Only required for stream messages (`type="stream"`), ignored otherwise. Maximum length of 60 characters. |

0 commit comments

Comments
 (0)