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

ZenZap Long Polling API

Long polling allows your integration to fetch outbound events instead of receiving webhooks.Use `GET /v2/updates` with:- `offset`: value returned as `nextOffset` from the previous response- `limit`: max updates per request (default 50, max 100)- `timeout`: wait time in seconds when no updates are available (default 0, max 30)Event payloads in polling responses match webhook `data` payloads for the same event type.This includes `data.message.attachments[]` with signed URLs for file/image/video/audio messages.

ZenZap Long Polling API is one of 8 APIs that ZenZap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Long Polling. The published artifact set on APIs.io includes an OpenAPI specification and rate-limit docs.

This API exposes 1 operation across 1 path, and defines 16 schemas. It is described by OpenAPI 3.0.3, at version 2.0.0.

Requests are made against a single base URL, https://api.zenzap.co.

1 operations 1 paths 16 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://api.zenzap.co
Authentication
HTTP Bearer, API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 3

ZenZap Long Polling API declares 3 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-Signature (hmacSignature). It supports OAuth 2.0 (oauth2ClientCredentials) using the clientCredentials flow, exposing 12 scopes. By default, every request must be authenticated.

  • bearerAuth — Bearer token for the request. Two flavors: - Static API key — pass your API key (the value returned as apiKey when the bot was created). Must be paired with X-…
  • hmacSignature — HMAC-SHA256 signature for request verification. Required only when authenticating with a static API key. Omit when using an OAuth access token.
  • oauth2ClientCredentials — OAuth 2.0 clientcredentials grant for API-key bots. Use the clientId and clientSecret returned when the bot was created (or rotated) to mint short-lived access…

Paths & Operations 1

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

Long Polling 1

Long polling allows your integration to fetch outbound events instead of receiving webhooks. Use GET /v2/updates with: - offset: value returned as nextOffset from the previous res…

GET
/v2/updates
Get updates (long polling)
getUpdates 5 params → 200400401409500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are WebhookMessage (17 properties), WebhookTask (10 properties), WebhookReactionData (7 properties), WebhookContact (7 properties). Each schema is shown below with its type and property counts.

WebhookMessageDeletedData
object
5 properties 2 required
WebhookTranscription
object
Transcription data for audio attachments (voice messages). Transcription flow: 1. message.created arrives with transcription.status: "Pending" 2. message.updat…
2 properties
WebhookAttachment
object
File attachment with download URL. URLs are signed and expire after 60 minutes. Download files promptly after receiving the webhook.
5 properties
WebhookReactionObject
object
5 properties
PollingUpdate
object
4 properties 4 required
MessageMention
object
2 properties
WebhookLocation
object
Shared location data
4 properties
WebhookMessageCreatedData
object
2 properties 1 required
WebhookTask
object
Task snapshot sent when a task is created, updated, or its status changes. The action field indicates what triggered this snapshot.
10 properties
WebhookReactionData
object
7 properties 4 required
UpdatesResponse
object
2 properties 2 required
WebhookContact
object
Shared contact information
7 properties
WebhookTopicUpdatedData
object
5 properties 1 required
WebhookMessage
object
Message object as delivered in webhook events. Includes additional fields not present in the REST API response, such as message type-specific data.
17 properties 7 required
WebhookMessageUpdatedData
object
3 properties 1 required
WebhookMemberData
object
6 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zenzap-long-polling-api-openapi.yml Raw ↑

Other APIs ZenZap publishes across the network.

ZenZap Agentic API
ZenZap Members API
ZenZap Messages API
ZenZap OAuth API
ZenZap Polls API
ZenZap Tasks API
ZenZap Topics (group chats/channels/conversations) API