# Collaborate Mode: "Start collaborate mode immediately" and onCollaborateRequest

**URL:** <https://devforum.zoom.us/t/collaborate-mode-start-collaborate-mode-immediately-and-oncollaboraterequest/125384>\
**Category:** Zoom Apps\
**Created:** [January 27, 2025, 4:49pm UTC](https://devforum.zoom.us/t/collaborate-mode-start-collaborate-mode-immediately-and-oncollaboraterequest/125384 "2025-01-27T16:49:05Z")\
**Posts on this page:** 5\
**Page:** 1

<div class="post-metadata">

**Author:** ![Jim-Bar](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/jim-bar/32/66681_2.png) [@Jim-Bar](https://devforum.zoom.us/u/Jim-Bar)\
**Post date:** [January 27, 2025, 4:49pm UTC](https://devforum.zoom.us/t/collaborate-mode-start-collaborate-mode-immediately-and-oncollaboraterequest/125384/1 "2025-01-27T16:49:05Z")

</div>

Hello,

I find the documentation to be lacking about the feature “_Start collaborate mode immediately_” which can be found in the app configuration at _Surface_ \> _Collaborate Mode_.

The description of “_Start collaborate mode immediately_” specifies:

> Enable this to start collaborate mode immediately after clicking the Collaborate button. **When disabled, clicking the Collaborate button will trigger the onCollaborateRequest event** , which notifies the app that collaborate mode was requested

But in the Zoom appssdk documentation I cannot find anything about this event “_onCollaborateRequest_”.

Scanning the repository of the SDK I do not find any mention of it either.

The feature seems to be working though, as when disabled, clicking on “_Collaborate_” in a Zoom meeting will show a spinner as if Zoom is waiting for my app to do something.

But I cannot find how to listen for this event. How is it supposed to work?

Thanks,

---

<div class="post-metadata">

**Author:** ![Jim-Bar](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/jim-bar/32/66681_2.png) [@Jim-Bar](https://devforum.zoom.us/u/Jim-Bar)\
**Post date:** [February 3, 2025, 10:44am UTC](https://devforum.zoom.us/t/collaborate-mode-start-collaborate-mode-immediately-and-oncollaboraterequest/125384/2 "2025-02-03T10:44:47Z")

</div>

Hi, I am still searching for solution to do this, does someone have any information?

---

<div class="post-metadata">

**Author:** ![donte.zoom](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/donte.zoom/32/24412_2.png) [@donte.zoom](https://devforum.zoom.us/u/donte.zoom)\
**Post date:** [February 11, 2025, 10:57pm UTC](https://devforum.zoom.us/t/collaborate-mode-start-collaborate-mode-immediately-and-oncollaboraterequest/125384/3 "2025-02-11T22:57:13Z")

</div>

Thank you for posting in the Zoom Developer Forum, @Jim-Bar! Have you checked the OnCollaborateChangeEvent ? It looks like you may have caught a documentation type. Can you share the link to that documentation and I will submit a update request ?

> **[ZoomSdk | @zoom/appssdk - v0.16.25](https://appssdk.zoom.us/classes/ZoomSdk.ZoomSdk.html#onCollaborateChange)**
>
> Documentation for @zoom/appssdk - v0.16.25

 ![image](https://us1.discourse-cdn.com/flex016/uploads/zoomdeveloper/original/3X/a/3/a3a4c4f2240146dcd1dd274417f33377ab41ccaf.png)

> **[OnCollaborateChangeEvent | @zoom/appssdk - v0.16.25](https://appssdk.zoom.us/types/ZoomSdkTypes.OnCollaborateChangeEvent.html)**
>
> Documentation for @zoom/appssdk - v0.16.25

---

<div class="post-metadata">

**Author:** ![Jim-Bar](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/jim-bar/32/66681_2.png) [@Jim-Bar](https://devforum.zoom.us/u/Jim-Bar)\
**Post date:** [February 12, 2025, 8:43am UTC](https://devforum.zoom.us/t/collaborate-mode-start-collaborate-mode-immediately-and-oncollaboraterequest/125384/4 "2025-02-12T08:43:50Z")

</div>

Hi @donte.zoom

The event I am talking about is documented in the app configuration on the Marketplace. See this image (sorry the forum won’t let me post an image nor a link):

`https://ibb.co/7xgRHDP3`

As I understand it, an event should be fired when clicking the blue button “Collaborate” with this checkbox unchecked.

I checked `onCollaborateChange`, but this event is not fired when clicking the “Collaborate” button, so it is most likely not this event I am looking for.

---

<div class="post-metadata">

**Author:** ![Jim-Bar](https://sea2.discourse-cdn.com/flex016/user_avatar/devforum.zoom.us/jim-bar/32/66681_2.png) [@Jim-Bar](https://devforum.zoom.us/u/Jim-Bar)\
**Post date:** [March 6, 2025, 1:23pm UTC](https://devforum.zoom.us/t/collaborate-mode-start-collaborate-mode-immediately-and-oncollaboraterequest/125384/5 "2025-03-06T13:23:21Z")

</div>

Follow up on this issue in the Zoom chat community discussion:

> **Donte Small** _Feb 18, 09:57_  
> The “onCollaborateRequest” event is not yet available for use., and we are working on updating the Marketplace configuration.
