Zoom Webhooks Source
The Zoom Webhooks Source receives events from Zoom webhooks. Zoom posts each event to this Source. This Source verifies the HMAC-SHA256 signature on the request and answers Zoom URL validation challenges. A URL validation challenge doesn’t create an event.
Type: Push | TLS Support: Yes | Event Breaker Support: Yes
Configure a Zoom Webhooks Source
- On the top bar, select Products, and then select Cribl Stream. Under Worker Groups, select a Worker Group. Next, you have two options:
- To configure via QuickConnect, navigate to Routing > QuickConnect. Select Add Source and select the Source you want from the list, choosing either Select Existing or Add New.
- To configure via the Routes, select Data > Sources. Select Add Source, and then select Zoom Webhooks.
- In the New Source modal, configure the following under General Settings:
- Input ID: Enter a unique name to identify this Source definition. If you clone this Source, Cribl Stream adds
-CLONEto the original Input ID. - Description: Optionally, enter a description.
- Address: Enter the hostname or IP address on which to listen for HTTP or HTTPS data. Defaults to
0.0.0.0. - Port: Enter the port number on which to listen. For Cribl.Cloud, use the
20000-20010port range.
- Input ID: Enter a unique name to identify this Source definition. If you clone this Source, Cribl Stream adds
- Under Optional Settings, configure the following:
- Tags: Add tags that you can use to filter and group Sources. These tags aren’t added to processed events.
- Under Authentication, select a Secret token (text secret). See Authentication.
- Optionally, adjust the TLS, persistent queue, Processing, and Advanced settings, or Connected Destinations.
- Select Save, then Commit & Deploy.
- In Zoom, validate the endpoint URL for this Source. Confirm that a subscribed event arrives. See Configure Zoom to Send Events.
TLS Settings (Server Side)
On Cribl.Cloud, you can enable TLS using Cribl-provided certificates.
Enabled: Toggle on to enable Transport Layer Security (TLS) on this connection. Defaults to toggled off. When toggled on, configure the following settings.
Under Server Certificate, select a certificate from the store to auto-fill the paths, or enter them manually:
- Certificate: Select an existing certificate name from the drop-down or add a new certificate by selecting Create. See adding a certificate on a Worker Group.
- Certificate path: Enter the server path that contains certificates in Privacy Enhanced Mail (PEM) format. You can reference
$ENV_VARS. - Private key path: Enter the server path that contains the private key in PEM format. You can reference
$ENV_VARS. - Passphrase: Enter the passphrase used to decrypt the private key.
Under Mutual Authentication (mTLS):
- Authenticate client (mutual auth): Toggle on to require clients to present certificates. Defaults to toggled off. When toggled on, configure these settings:
- Trusted client CA path: Enter the server path that contains the certificate authority (CA) certificates to trust as the chain root when verifying a client’s identity. You can reference
$ENV_VARS. - Validate client certificates: Toggle on to reject certificates that aren’t authorized by a CA in the Trusted client CA path or by another trusted CA. Defaults to toggled on.
- Common name: Enter a regex to match against the CN and SAN fields in the client certificate. Cribl Stream rejects clients unless it finds at least one match. Defaults to
/.*/.
- Trusted client CA path: Enter the server path that contains the certificate authority (CA) certificates to trust as the chain root when verifying a client’s identity. You can reference
Under TLS Version, reject clients using TLS versions below or above these thresholds:
- Minimum TLS version: Select the minimum TLS version to accept. Selecting
TLSv1orTLSv1.1shows a deprecation warning. - Maximum TLS version: Select the maximum TLS version to accept.
Authentication
Secret token (text secret): Required. Select a stored text secret that contains the Zoom webhook secret token. Cribl Stream uses that token to verify x-zm-signature and to answer URL validation challenges. Choose Select local secret or Select global secret, select a text secret, or select Create text secret. See Create and manage secrets and Global secrets.
Persistent Queue Settings
In the Persistent Queue Settings tab, you can optionally specify persistent queue storage, using the following controls. Persistent queue buffers and preserves incoming events when a downstream Destination has an outage or experiences backpressure.
Before enabling persistent queue, learn more about persistent queue behavior and how to optimize it with your system:
On Cribl-managed Cloud Workers (with an Enterprise plan), this tab exposes only the Enable persistent queue toggle. If enabled, PQ is automatically configured in
Always Onmode, with a maximum queue size of 1 GB disk space allocated per PQ-enabled Source, per Worker Process.The 1 GB limit is on uncompressed inbound data, and the queue does not perform any compression. This limit is not configurable. For configurable queue size, compression, mode, and other options below, use a hybrid Group.
All other settings described in this section apply to on-prem and hybrid deployments only.
Enable persistent queue: Default is toggled off. When toggled on:
Mode: Select a condition for engaging persistent queues.
Always On: This default option will always write events to the persistent queue, before forwarding them to the Cribl Stream data processing engine.Smart: This option will engage PQ only when the Source detects backpressure from the Cribl Stream data processing engine.Smartmode only engages when necessary, such as when a downstream Destination becomes blocked and the Buffer size limit reaches its limit. When persistent queue is set toSmartmode, Cribl Stream attempts to flush the queue when every new event arrives. The only time events stay in the buffer is when a downstream Destination becomes blocked.
Deprecation Notice
To improve data integrity, Smart mode is deprecated for Source persistent queue on hybrid and on-prem deployments. In January 2027, affected configurations will automatically migrate to Always On mode. Consider updating existing configurations to Always On mode prior to the automatic migration date. Before changing the configuration:
- Monitor your persistent queue usage so that you can allocate enough disk space.
- Before making changes to your persistent queue, remember to drain the queues first to avoid orphaned data.
- Verify that data routing and filtering behaves as expected in a test environment before rolling out the new configuration to production.
Buffer size limit (bytes): The maximum memory to buffer events before flushing them to persistent queue on disk. Enter a value with a unit suffix. For example: 64KB, 1MB, or 10MB. Spaces between the number and unit are allowed (such as 64 KB). Units are case-insensitive. Plain byte values (like 65536) are accepted, but decimals (like 0.5MB) are not. The valid range is 64KB to 10MB. Values outside this range are rounded to the nearest limit. Defaults to 1MB.
Deprecation Notice
The Buffer size limit (bytes) setting replaces the deprecated Buffer size limit (events) setting as of version 4.18.0 to provide more predictable memory management. For upgraded Worker Groups and Fleets, the new byte-based limit defaults to
1MB. Update your configurations to use the byte-based limit to ensure optimal memory stability.
Commit frequency: The number of events to send downstream before committing that Cribl Stream has read them. Defaults to 42.
File size limit: The maximum data volume to store in each queue file before closing it and (optionally) applying the configured Compression. Enter a numeral with units of KB, MB, and so on. If not specified, Cribl Stream applies the default 10 MB. When you save the configuration, File size limit must be greater than or equal to Buffer size limit (bytes). Cribl Stream rejects invalid combinations.
Queue size limit: The maximum amount of disk space that the queue is allowed to consume on each Worker Process. Once this limit is reached, this Source stops queueing data and applies the Queue-full behavior. Required, and defaults to 5 GB. Accepts positive numbers with units of KB, MB, GB, and so on. Can be set as high as 1 TB, unless you’ve configured a different Worker Process PQ size limit in Group or Fleet settings.
Queue file path: The location for the persistent queue files. Defaults to $CRIBL_HOME/state/queues. To this field’s specified path, Cribl Stream appends /<worker-id>/inputs/<input-id>.
Compression: Optional codec to compress the persisted data after a file closes. Defaults to None; Gzip is also available.
Queue-full behavior: Whether to block or drop events when the queue begins to exert backpressure. A queue begins to exert backpressure when the disk is low or at full capacity.
- Block (Default): Does not accept new data until the queue has capacity. When the sender supports backpressure signaling, Cribl Stream returns block signals to the sender.
- Drop new data: Discards incoming events while leaving the contents of the persistent queue unchanged.
In Cribl Stream 4.1 and newer, the Source persistent queue default Mode is
Always on, to best ensure events’ delivery. For details on optimizing this selection, see Optimize Source Persistent Queues.You can optimize Workers’ startup connections and CPU load at Group/Fleet settings > Worker Processes.
Processing Settings
Event Breakers
Event Breaker rulesets: Select the rulesets to apply before sending data through Routes. Defaults to Zoom Webhooks. That ruleset keeps each request body as one event, including a body that contains line breaks. It extracts the fields from the request body and sets _time from event_ts when event_ts is a positive number. event_ts is Unix time in milliseconds, and Cribl Stream stores _time in seconds. When event_ts is missing, _time is the time Cribl Stream received the event.
Event Breaker buffer timeout (ms): Enter how long, in milliseconds, the Event Breaker waits for more data on a channel before flushing the stream to Routes. Defaults to 10000. The minimum is 10 and the maximum is 43200000.
Fields
Select Add Field to add fields to each event using Eval-like functionality:
- Field Name: Enter the field name.
- Value: Enter a JavaScript expression that determines the field’s value.
Pre-Processing
Pipeline: From the drop-down, select one Pipeline or Pack to process data before sending it through Routes.
Advanced Settings
Show originating IP: Toggle on to extract the client IP address and port from PROXY protocol v1 or v2. When toggled on, Cribl Stream ignores the X-Forwarded-For header. Defaults to toggled off.
Health check endpoint: Toggle on to enable http(s)://<host>:<port>/cribl_health for this Source. A healthy Source returns HTTP 200.
Capture request headers: Toggle on to add request headers to events in the __headers field. Defaults to toggled off.
When Capture request headers is enabled, this Source stores request headers in the
__headersfield. Dynamic headers field names the event field that some Destinations read for outbound headers. It defaults to__headerson HTTP Destinations such as Webhook, Loki, Microsoft Sentinel, Dynatrace HTTP, and Cortex XSIAM. Kafka Destinations saved before this setting existed also read__headersfor message headers. New Kafka Destinations default to__headersOut. Other Destinations that read__headerscan be affected the same way. Forwarding captured events while that field is__headerscan cause TLS validation failures or expose inbound authentication headers. Use an Eval Function in a Pipeline to remove__headers(or copy it to another field name, then remove__headers) before the Destination, or set Dynamic headers field to a different field. See__headersfield conflicts.
Allowed URI paths: Enter the URI paths this Source accepts. Supports wildcards, such as /api/v*/hook. Defaults to *, which allows every path. You can bind this field to a variable.
Allowed HTTP methods: Enter the HTTP methods this Source accepts. Supports wildcards, such as P* or GET. Defaults to *, which allows every method.
Active request limit: Enter the maximum number of active requests allowed per Worker Process. Defaults to 256. Enter 0 for unlimited. This setting is available only for on-prem deployments.
Activity log sample rate: Enter how often Cribl Stream logs request activity at the info level. Defaults to 100, which logs every 100th request. The minimum value is 1.
Requests-per-socket limit: Enter the maximum number of requests allowed per socket before Cribl Stream instructs the client to close the connection. Defaults to 0, which allows unlimited requests.
Socket timeout (seconds): Enter how long Cribl Stream waits before treating an inactive socket as timed out. Defaults to 0, which waits indefinitely.
Request timeout (seconds): Enter how long Cribl Stream waits for an incoming request to complete before aborting it. Defaults to 0, which disables the timeout. An expired request can return HTTP 408. Zoom does not retry 4xx responses, so setting this timeout can cause an incomplete delivery to be lost.
Keep-alive timeout (seconds): Enter how long Cribl Stream waits for more data after sending the last response. Defaults to 5 seconds. The minimum is 1 second, and the maximum is 600 seconds.
IP allowlist regex: Enter a regex that matches IP addresses whose messages Cribl Stream processes, unless the denylist also matches. Defaults to /.*/.
IP denylist regex: Enter a regex that matches IP addresses whose messages Cribl Stream ignores. The denylist takes precedence over the allowlist. Defaults to /^$/.
Environment: If you’re using GitOps, enter the Git branch on which to enable this configuration. Leave blank to enable the configuration everywhere.
Connected Destinations
Select Send to Routes to enable conditional routing, filtering, and cloning of this Source’s data via the Routing table.
Select QuickConnect to send this Source’s data to one or more Destinations via independent, direct connections.
Configure Zoom to Send Events
After you configure this Source, add an event subscription in Zoom and point it at this Source. The Zoom webhooks documentation describes how to create the subscription and where Zoom displays the secret token.
- Set the event notification endpoint URL to
https://<public-hostname>:<port><path>.<public-hostname>is a fully qualified domain name that Zoom can reach on the public internet, and<port>is the public port for that hostname. Zoom requires a publicly accessible HTTPS URL on a fully qualified domain name. The Source Address defaults to0.0.0.0and is the address this Source listens on. TLS can terminate on this Source when TLS is toggled on, or at a load balancer in front of this Source.<path>must match Allowed URI paths. The default*accepts any path. - Copy the Zoom secret token into the text secret you selected under Authentication.
- Validate the endpoint URL. Zoom posts an
endpoint.url_validationevent. This Source answers that challenge and doesn’t create an event. - Subscribe to the Zoom events you want this Source to receive.
How Cribl Stream Verifies Zoom Requests
Cribl Stream reads two headers on every request:
x-zm-request-timestamp: Unix time, in seconds, when Zoom sent the request.x-zm-signature:v0=followed by the hex HMAC-SHA256 ofv0:{timestamp}:{raw body}, keyed by the Secret token (text secret).
Cribl Stream rejects the request with HTTP 401 and the message Access denied when the timestamp is missing or not fresh, or when the signature doesn’t match. A timestamp is fresh when it is no more than 90 minutes old and no more than 5 minutes ahead of this Source. That window covers Zoom’s retry schedule.
When the event is endpoint.url_validation and payload.plainToken is a string, Cribl Stream replies HTTP 200 with plainToken and encryptedToken. encryptedToken is the hex HMAC-SHA256 of plainToken, keyed by the Secret token (text secret). That reply doesn’t enter Routes.
Every other signed request receives HTTP 204 with an empty body as soon as the signature check succeeds. Cribl Stream then sends that request through the Event Breakers and Routes. See Response Timing and Duplicate Events.
Zoom retries a delivery that returns HTTP 500 or higher, or that fails before Zoom receives a response. Zoom does not retry 3xx or 4xx responses. The first retry is 5 minutes after the original delivery. The next retry is 20 minutes after the first. The last retry is 60 minutes after the second. See Zoom Notification delivery.
A request body larger than 1 MiB can return HTTP 413 and the message Payload too large. This Source can close the connection before that response reaches the client, so the client may see a connection reset instead.
Response Timing and Duplicate Events
Zoom expects a 200 or 204 within 3 seconds. For a signed event, Cribl Stream returns HTTP 204 with an empty body as soon as the signature check succeeds. That response is sent before the event reaches the Event Breakers, the persistent queue, or Routes, so downstream backpressure does not delay it.
If Zoom does not receive that response within 3 seconds, or the response is HTTP 500 or higher, Zoom retries the delivery. The timestamp check still accepts a retry of an event this Source already accepted. Cribl Stream doesn’t remove the duplicate. Handle duplicate events downstream when your workflow requires unique events.
Internal Fields
Cribl Stream uses internal fields to help process data from this Source:
__headers: Contains request headers when Capture request headers is toggled on.__queryParams: Contains the request URL’s query parameters, nested in this field.__srcIpPort: Contains the source IP address and port.
Troubleshooting
The Source’s configuration modal has helpful tabs for troubleshooting:
Live Data: Try capturing live data to see real-time events as they are ingested. On the Live Data tab, click Start Capture to begin viewing real-time data.
Logs: Review and search the logs that provide detailed information about the ingestion process, including any errors or warnings that may have occurred.
You can also view the Monitoring page that provides a comprehensive overview of data volume and rate, helping you identify ingestion issues. Analyze the graphs showing events and bytes in/out over time.
__headers Field Conflicts with Destinations
When Capture request headers is enabled, this Source writes inbound headers to the __headers field. Dynamic headers field names the event field that some Destinations read for outbound HTTP headers or Kafka message headers. It defaults to __headers, so the fields can interfere silently. Destinations that default to __headers include Webhook, Loki, Microsoft Sentinel, Dynatrace HTTP, and Cortex XSIAM. Kafka Destinations saved before this setting existed also read __headers. New Kafka Destinations default to __headersOut. Other Destinations that read __headers can be affected the same way.
In that case, events can leave Cribl Stream successfully (Source, Route, and Destination metrics look healthy) while data does not arrive or is rejected downstream. Destination logs may show no errors, or you may see TLS certificate or hostname validation failures, or authentication errors such as invalid audience.
To avoid the conflict, use an Eval Function in a Pipeline to remove __headers before the Destination, or set Dynamic headers field to a field other than __headers. To keep the captured headers under another name, add a field that copies __headers, then remove __headers (the Rename Function cannot operate on fields whose names begin with __). If TLS or certificate errors appear and __headers contains a host value, you can also toggle Validate server certs off on the Destination. That weakens TLS verification, so use it only after you confirm the conflict is the cause.
Zoom Webhooks Source Requires a Secret Token
The Source reports Zoom Webhooks source requires a secret token when Secret token (text secret) doesn’t resolve to a token. Select a text secret that contains the Zoom webhook secret token, and then select Save and Commit & Deploy.
Access Denied
A request returns HTTP 401 and the message Access denied when x-zm-request-timestamp is missing, older than 90 minutes, or more than 5 minutes in the future, or when x-zm-signature doesn’t match the Secret token (text secret) and the raw body. Use the secret token from the same Zoom app that sends the events.
Invalid CRC Challenge
A URL validation request returns HTTP 400 and the message Invalid CRC challenge when the event is endpoint.url_validation but payload.plainToken isn’t a string. Cribl Stream doesn’t send that request through Routes.
Payload Too Large
A request body larger than 1 MiB can return HTTP 413 and the message Payload too large. This Source can close the connection before that response reaches the client, so the client may see a connection reset instead.
Unallowed Path
A request returns HTTP 403 and the message Unallowed path when the URL path doesn’t match Allowed URI paths. Set the Zoom endpoint URL to a path this Source accepts, or set Allowed URI paths to *.