Zulip homepage

API documentation home

Integrations

Interactive bots (beta)

REST API

Messages

Drafts

Streams

Users

Server & organizations

Real-time events

Specialty endpoints

Back to Zulip

Add a linkifier

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

POST https://zulip.schiffrin-zulip.cloud.edu.au/api/v1/realm/filters

Usage examples

  • Python
  • curl

#!/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 -sSX POST https://zulip.schiffrin-zulip.cloud.edu.au/api/v1/realm/filters \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    --data-urlencode 'pattern=#(?P<id>[0-9]+)' \
    --data-urlencode 'url_format_string=https://github.com/zulip/zulip/issues/%(id)s'

Parameters

pattern string required

Example: "#(?P<id>[0-9]+)"

The Python regular expression that should trigger the linkifier.

url_format_string string required

Example: "https://github.com/zulip/zulip/issues/%(id)s"

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: integer

    The numeric ID assigned to this filter.

Example response

A typical successful JSON response may look like:

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