POST /realm/playgrounds

Configure code playgrounds for the organization.

Changes: New in Zulip 4.0 (feature level 49). A parameter encoding bug was fixed in Zulip 4.0 (feature level 57).

Servers

https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description

Name	Type	Required	Description
`name`	String	Yes	The user-visible display name of the playground which can be used to pick the target playground, especially when multiple playground options exist for that programming language.
`pygments_language`	String	Yes	The name of the Pygments language lexer for that programming language.
`url_template`	String	Yes	The RFC 6570 compliant URL template for the playground. The template should contain exactly one variable named `code`, which determines how the extracted code should be substituted in the playground URL. Changes: New in Zulip 8.0 (feature level 196). This replaced the `url_prefix` parameter, which was used to construct URLs by just concatenating `url_prefix` and `code`.

name

String

Yes

The user-visible display name of the playground which can be used to pick the target playground, especially when multiple playground options exist for that programming language.

pygments_language

String

Yes

The name of the Pygments language lexer for that programming language.

url_template

String

Yes

The RFC 6570 compliant URL template for the playground. The template should contain exactly one variable named code, which determines how the extracted code should be substituted in the playground URL.

Changes: New in Zulip 8.0 (feature level 196). This replaced the url_prefix parameter, which was used to construct URLs by just concatenating url_prefix and code.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.