Create linkifiers

Configure linkifiers, regular expression patterns that are automatically linkified when they appear in messages and topics.

POST https://yourZulipDomain.zulipchat.com/api/v1/realm/filters

Usage examples

#!/usr/bin/env python3

import zulip

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

# Add a filter to automatically linkify #<number> to the corresponding
# issue in Zulip's server repo
result = client.add_realm_filter('#(?P<id>[0-9]+)',
                                 'https://github.com/zulip/zulip/issues/%(id)s')
print(result)

curl -X POST https://yourZulipDomain.zulipchat.com/api/v1/realm/filters \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d "pattern=#(?P<id>[0-9]+)" \
    -d "url_format_string=https://github.com/zulip/zulip/issues/%(id)s"

Arguments

Argument Example Required Description
pattern "#(?P<id>[0-9]+)" Yes

The Python regular expression that should trigger the linkifier.

url_format_string "https:\/\/github.com\/zulip\/zulip\/issues\/%(id)s" Yes

The URL used for the link. If you used named groups for the pattern, you can insert their content here with %(name_of_the_capturing_group)s.

Response

Return values

  • id: The numeric ID assigned to this filter.

Example response

A typical successful JSON response may look like:

{
    "id": 42,
    "msg": "",
    "result": "success"
}