Push Notifications for REST API

Push notifications can be used as alerts to keep your systems in sync with actions inside Zoom. Push notifications themselves should not be used as actionable items-Zoom recommends always verifying the data included in a push notification with an API query.

Zoom can send notification to any publicly accessible server. When an event in Zoom triggers a push notification (e.g. a meeting is started, or closed), Zoom will attempt to send this notification to the endpoint you specify.

Zoom sends push notifications for meeting start, meeting end and recording ready events.

Zoom only considers a notification delivered if it receives a timely response with a successful status code. In other words:

  • Your endpoint must be reachable at ports 80 (HTTP) or 443 (HTTPS) (Zoom does not support other ports).
  • Your endpoint must respond within 30 seconds.
  • Your endpoint must respond with a 2XX status code (200, 204). Zoom does not follow redirects or consider them successful responses)

Zoom will try max to 3 times for one event. If all 3 times notification fail, this event will be discard.

Parameters

Zoom will pass following parameters to your subscribe URL via POST HTTP request

Parameters Description
id Meeting id.
uuid Meeting uuid.
status Meeting status. "STARTED" means the meeting is started, "ENDED" means the meeting is ended.
host_id Meeting host id.

Generate authorization in header

Most programming languages encode the authorization header automatically. With HTTP Basic Authentication, the Authorization header is a string containing a Base-64 encoded username and password. Zoom push notification also supports HTTP Basic Authentication, you can specify the username and password when enabling push notification subscription.

"Authorization": "Basic " + base64_encode(username + ":" + password)

To Enable Push Notifications

Go to Credential page and click Enable Push Notification.