Get all alert words

GET https://cdfa-phs.zulipchat.com/api/v1/users/me/alert_words

Get all of the user's configured alert words.

Usage examples

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Get all of the user's configured alert words.
result = client.get_alert_words()
print(result)

curl -sSX GET -G https://cdfa-phs.zulipchat.com/api/v1/users/me/alert_words \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY

Parameters

This endpoint does not accept any parameters.

Response

Return values

• alert_words: (string)[]

  An array of strings, where each string is an alert word (or phrase) configured by the user.

Example response(s)

Changes: As of Zulip 7.0 (feature level 167), if any parameters sent in the request are not supported by this endpoint, a successful JSON response will include an ignored_parameters_unsupported array.

A typical successful JSON response may look like:

{
    "alert_words": [
        "natural",
        "illustrious"
    ],
    "msg": "",
    "result": "success"
}