Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zulip webhooks API

The webhooks API from Zulip — 1 operation(s) for webhooks.

Zulip webhooks API is one of 17 APIs that Zulip publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include webhooks. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against 5 base URLs: https://{subdomain}.zulipchat.com/api/v1, {server}/api/v1, https://chat.zulip.org/api/v1, http://localhost:9991/api/v1, http://{subdomain}.testserver/json.

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Servers
https://{subdomain}.zulipchat.com/api/v1
{server}/api/v1
https://chat.zulip.org/api/v1
http://localhost:9991/api/v1
http://{subdomain}.testserver/json
Authentication
HTTP Basic
License
Resource Areas
1

Authentication & Security 1

Zulip webhooks API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — Basic authentication, with the user's email as the username, and the API key as the password. The API key can be fetched using the /fetchapikey or /devfetchapi…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

webhooks 1
POST
/zulip-outgoing-webhook
Outgoing webhooks
zulip-outgoing-webhooks → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are MessagesBase (22 properties), EmojiBase (3 properties). Each schema is shown below with its type and property counts.

EmojiBase
object
3 properties
EmojiReaction
MessagesBase
object
Object containing details of the message.
22 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zulip-webhooks-api-openapi.yml Raw ↑

Other APIs Zulip publishes across the network.

Zulip REST API
Zulip Events API
Zulip Webhooks
Zulip authentication API
Zulip bots API
Zulip channels API
Zulip drafts API
Zulip invites API
Zulip messages API
Zulip mobile API
Zulip navigation_views API
Zulip real_time_events API