> For the complete documentation index, see [llms.txt](https://library.zoom.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://library.zoom.com/technical-library/nl/beheerdershoek/third-party-integrations/zoom-calendaring-integration-explainer/zoom-calendaring-endpoints.md). # Zoom-agenda-eindpunten ### Web-agendadienst De Web-agendadienst vormt de kern van Zooms mogelijkheid om agendainformatie aan alle Zoom Apps te leveren. #### Welke informatie slaat Zoom op? De Zoom Web Calendaring Service slaat de objecten op die vereist zijn om de agenda-aanbieder van elke gebruiker te authenticeren. Dit betekent dat Zoom het refresh token opslaat wanneer organisaties OAuth gebruiken om Outlook of Google Agenda te verbinden met Zoom-diensten. Het betekent ook dat Zoom, voor organisaties die Basis authenticatie gebruiken in Exchange On-Premises, de account Gebruikersnaam en het wachtwoord opslaat. | Gesynchroniseerde Evenementen | | ----------------------------- | | `deelnemersWeggelaten` | | `beschrijving` | | `weergavenaam` (deelnemer) | | `E-mail` (deelnemer) | | `vasteWerkLocatie` | | `iCalUID` | | `Locatie` | | `weergavenaam` (organisator) | | `E-mail` (organisator) | | `samenvatting` | | `tijdsvoorstel` | | `werkLocatieIngeschakeld` | Wanneer tweerichtings agenda Synchroniseren (Synchroniseren 2.0) is ingeschakeld, bewaart Zoom geen externe agenda Evenement-gegevens (van Microsoft 365 of Google Agenda) in zijn database.\ \ In plaats daarvan bewaakt de service een voortschrijdend venster van 24 maanden aan agenda-activiteit (tot 6 maanden in het verleden en 18 maanden in de toekomst). Als er Wijzigen optreden binnen dit venster, ontvangt Zoom wijzigingsmeldingen van de agenda-aanbieder en haalt het op aanvraag de bijgewerkte Evenement-gegevens op om de bijbehorende Zoom-vergaderingupdates te verwerken. De vergaderingservice wordt vervolgens op de hoogte gebracht om de vereiste wijzigingen toe te passen. Beheerders kunnen deze Functie(s) op account- of gebruiker Groep-niveau Configureer. Raadpleeg onze [ondersteuningsdocumentatie](https://support.zoom.us/hc/en-us/articles/8522918261645-Enabling-bi-directional-calendar-sync) voor meer informatie. #### Hoe worden opgeslagen tokens en inloggegevens beschermd? De opgeslagen tokens en inloggegevens worden in rust versleuteld met AES-GCM-encryptie van 256 bits. Deze gegevens worden beschouwd als klantinhoud en vallen onder Zoom’s toegangscontrolebeleid en -standaarden. Deze controles worden beoordeeld door onafhankelijke accountantskantoren, waar vermeld in onze beveiligingscertificeringen en attestaties, zoals de SOC 2. Bevoegde toegang tot infrastructuurgegevens en systemen wordt gelogd, bewaakt en gecontroleerd met behulp van multi-factor authenticatie en toegangscontroles met minimaal noodzakelijke bevoegdheid. #### Hoe wordt het verkeer tussen apps en de agenda-provider beschermd? Communicatie tussen agenda-providers en alle Zoom-software — Zoom desktop-/mobiele apps, Zoom Web Agenda Service, planningstools en de API-Connector — wordt tijdens overdracht versleuteld met TLS 1.2. #### Hoe lang is een OAuth-token geldig? Zoom vraagt om access tokens die na 1 uur verlopen en refresh tokens die na 90 dagen verlopen, maar agenda-providers kunnen tokens met andere limieten aanbieden. Volg de instructies van uw provider als u de standaardwaarden wilt wijzigen. #### Kan ik een OAuth-token of inloggegeven intrekken? Zoom-beheerders kunnen ervoor kiezen om de agenda-integratie op elk moment uit een enkel Zoom-account te verwijderen, waardoor de agenda van de gebruiker niet meer functioneert. Verwijder onmiddellijk alle opgeslagen tokens of inloggegevens voor die gebruiker. Microsoft 365-beheerders kunnen Zoom’s agenda-toegang voor alle gebruikersaccounts verwijderen door de Zoom-applicatie te verwijderen in de Entra ID Onderneming Applicatie-portaal, en Google werkruimte-beheerders kunnen toegang intrekken via de Google Cloud Platform Console. #### Kan ik Zoom’s mogelijkheid beperken om agenda- of contactgegevens naar een provider te schrijven? Na de eerste configuratie kunnen Zoom-beheerders bij Verbinden via Microsoft 365-methoden kiezen tussen alleen-lezen- en lees-/schrijfrechten voor zowel agenda’s als contacten. Beheerders kunnen ook Google werkruimte-Integraties(s) voor gebruikersagenda’s beperken. ### Desktop- en mobiele apps #### Slaan de Zoom Apps enige agenda- of contactpersoongegevens op? Zoom Apps bewaren agendainformatie in tijdelijk geheugen (RAM) en slaan geen items permanent op de lokale schijf op. Dit omvat authenticatietokens, referenties, agenda Evenement-informatie en contactpersoongegevens. Deze gegevens zijn niet langer beschikbaar zodra de client wordt afgesloten. #### Wat gebeurt er bij aanmelding? Zoom Apps starten bij elke aanmelding een volledige verversing om de lijst met aankomende Evenementen op te halen. Hierbij ontvangen ze hun OAuth Access token of opgeslagen referenties van de Zoom Web-agendadienst en gebruiken vervolgens dat object om Evenementgegevens rechtstreeks van de agendaprovider te verversen. Als het Access token ongeldig is, gebruikt de Zoom Web-agendadienst het verversingstoken om een nieuw Access token aan te vragen en door te geven aan de client. #### Hoe weet de client dat hij zijn lijst met aankomende Evenementen moet verversen? De Zoom Web Agenda-service abonneert zich op een webhook van de agenda-provider voor elke gebruiker nadat de agenda is verbonden in het webportaal. Deze webhooks stellen de Web Agenda-service op de hoogte van eventuele wijzigingen, zodat deze vervolgens de Zoom-client kan melden dat een update nodig is. Ten slotte zal de Zoom-client rechtstreeks een update aanvragen bij de agenda-provider. Apps die geen Melding van een update ontvangen, verversen hun evenementenlijst elke 30 minuten. #### Welke details van de vergadering zijn beschikbaar voor de client? Zoom Apps geven gegevens van de vergadering weer nadat ze de Evenementen die het parseert hebben opgeschoond, wat betekent dat het alle attributen heeft verwijderd die het niet gebruikt. De Evenement-attributen die zijn opgeslagen voor gebruik en verwijderd, worden hieronder in de tabel beschreven. | Opgeslagen voor weergeven in de client | Verwijderd en niet behouden | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | | | | \*Alleen wanneer Evenementvastlegging, aangedreven door AI Companion 2.0, is ingeschakeld | | #### Worden er agenda-gegevens opgeslagen in clientlogs? Zoom apps schrijven geen gevoelige agenda-gegevens zoals tokens, inloggegevens of Evenementen naar clientlogs. ### Planningstools Zoom biedt een verscheidenheid aan hulpmiddelen om de Zoom-vergaderingsPlanning met Microsoft- en Google-producten te vereenvoudigen. Deze producten omvatten native Planning-integraties voor Google werkruimte en Microsoft 365, of software-extensies voor gebruik met Selecteer browsers en Outlook. #### Hoe werken de Planning-tools? Alle Planningstools, behalve de Outlook-invoegtoepassing, dienen rechtstreeks API-verzoeken in bij zowel de kalenderprovider als de Zoom Web Calendaring Service. De Outlook-invoegtoepassing verschilt daarin dat deze een vergadering plant via de Zoom-desktopclient, die het API-verzoek namens de Invoegtoepassing indient bij de Zoom Web Calendaring Service. #### Welke informatie wordt naar Zoom verzonden bij Planning met een tool? De enige gegevens die worden bewaard bij gebruik van een Planning-hulpmiddel zijn informatie die nodig is voor Een vergadering plannen. Bijvoorbeeld, wanneer een gebruiker een Zoom-vergadering in Planning brengt met behulp van de Microsoft 365 Toevoegen-invoegtoepassing, gebruikt de Toevoegen-invoegtoepassing het Evenementonderwerp, de datum, tijd, tijdzone en terugkeringsvlag om de Zoom-vergadering in Planning te brengen. De Zoom Toevoegen-invoegtoepassing vraagt niet om extra details zoals de hoofdtekst of de deelnemerlijst. #### Zijn er firewall- of beveiligingsvereisten? De Planningtools vereisen geen aanvullende firewall- of beveiligingswijzigingen bovenop wat al nodig is voor agenda-integraties. De volledige lijst met vereisten staat gedocumenteerd in [netwerk- en firewallregels voor Zoom](https://support.zoom.us/hc/en-us/articles/201362683-Network-firewall-or-proxy-server-settings-for-Zoom). #### Wat is het verschil tussen de Outlook-invoegtoepassing en de Outlook-invoegtoepassing? De Outlook-invoegtoepassing wordt geïnstalleerd op de machine van een Eindgebruiker en helpt gebruikers bij Planning van Zoom-vergaderingen via hun Outlook-client. De Invoegtoepassing communiceert met de Zoom Workplace-desktopclient via een kanaal voor interprocescommunicatie (IPC). Met deze IPC verstuurt de Invoegtoepassing planningsgegevens naar de webagenda-service van Zoom via de resources van de client. Om onze gebruikers de beste ervaring te bieden en tegelijkertijd te voldoen aan het beleid en de richtlijnen van Apple en Microsoft, beveelt Zoom ten zeerste de implementatie en het gebruik van de Zoom voor Outlook-invoegtoepassing aan. De invoegtoepassing biedt u eenvoudigere implementatie en robuustere administratieve beheeroplossingen, wordt actief ondersteund door Microsoft en voldoet beter aan de recent aangescherpte beveiligingsvereisten van leveranciers zoals Apple. {% hint style="danger" %} **Waarschuwing** Nieuwe Functie(s)-verbeteringen zullen niet worden geïmplementeerd voor de Zoom voor Outlook-invoegtoepassing. Het wordt sterk aangeraden om over te stappen op de Zoom voor Outlook-invoegtoepassing. {% endhint %} De Outlook-invoegtoepassing is een webgebaseerde applicatie waarvoor geen lokale installatie op machines van de gebruiker nodig is en die in plaats daarvan verschijnt als een ingebouwde web app, beschikbaar zowel in de lokale client als in Outlook op het web. De invoegtoepassing werkt via web-API's die rechtstreeks communiceren met de webagendaservice van Zoom. De Invoegtoepassing en de invoegtoepassing bieden vergelijkbare functionaliteit, maar de invoegtoepassing vereist dat de Outlook JavaScript API-vereistenset v1.8 — een versie die alleen bestaat in moderne versies van Outlook en helemaal niet beschikbaar is voor Exchange Server on-premises — beschikbaar is. Dit betekent: * De Outlook-invoegtoepassing kan niet worden gebruikt voor gedelegeerde Planning met Exchange Server on-premises. * Gedelegeerden moeten de Microsoft 365 Outlook-client, Outlook 2021 of later voor Mac/PC, of Outlook op het web gebruiken voor Planning van vergaderingen namens een andere gebruiker. #### Hoe kan ik de officiële Zoom-invoegtoepassing-applicatie herkennen? De officiële Zoom voor Outlook applicatie die beschikbaar is via de [Microsoft AppSource-winkel](https://appsource.microsoft.com/en-us/product/office/WA104381712?tab=Overview) wordt geïnstalleerd in uw Entra ID Onderneming Apps-map onder de naam “Zoom-Office-Toevoegen-in-SSO” met de applicatie-ID ce63c970-e2d7-45e6-bee1-80c330b0800b. #### Moet ik de Outlook-invoegtoepassing of Toevoegen-invoegtoepassing bijwerken? Vanaf januari 2025 is Microsoft begonnen met het vervangen van verouderde Exchange Online-tokens door Nested app authenticatie (NAA). Zoom-beheerders moeten, in samenwerking met Entra-beheerders, NAA Configureer binnen het Zoom-webportal volgens de instructies in het ondersteuningsartikel. [Geneste app-authenticatie configureren voor Office-invoegtoepassingen](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0078410). {% hint style="info" %} **Opmerking** Geneste app-authenticatie (NAA) wordt alleen ondersteund met Exchange Online. Organisaties die Exchange 2019 (of andere on-premises versies van Exchange) gebruiken, zullen Doorgaan met het gebruik van legacy Exchange-gebruikeridentiteitstokens en callbacktokens, aangezien deze niet worden geblokkeerd in on-premises omgevingen. {% endhint %} Anders is de invoegtoepassing Zoom voor Outlook een webgebaseerde applicatie die geen lokale installatie op gebruikersapparaten vereist en in plaats daarvan verschijnt als een ingebouwde webapplicatie die via web-API's werkt om te communiceren met Zoom's Web Calendaring Service. De invoegtoepassing is Beschikbaar voor Windows- en macOS-Outlook-apps, Android- en iOS-Outlook-apps en Outlook op het web. De invoegtoepassing kan worden geconfigureerd en massaal worden uitgerold door Outlook-beheerders of worden geïnstalleerd door individuele gebruikers. De Outlook-invoegtoepassing werkt als een geïnstalleerd softwareonderdeel, dat af en toe wordt bijgewerkt en verbeterd. Daarom vereist de Invoegtoepassing versiebeheer en upgrades in de loop van de tijd. {% hint style="info" %} **Opmerking** Authenticatie voor de geneste app is niet vereist voor de Outlook-invoegtoepassing. {% endhint %} #### Welke Planningstool is het meest geschikt voor mijn omgeving? **Google Werkruimte** Organisaties die Google Werkruimte gebruiken, kunnen eenvoudig alle gebruikers de Planning van Zoom Meetings via Google Agenda laten doen door de Zoom voor GSuite-app uit de Google Werkruimte Marketplace te installeren. De app wordt centraal beheerd en wordt automatisch bijgewerkt wanneer Zoom verbeteringen naar Google verzendt. Als alternatief zijn de browserextensies ook Beschikbaar voor gebruik, maar ze zijn over het algemeen geschikter voor gebruikers met een persoonlijk account omdat ze een lokale installatie, periodieke updates vereisen en niet centraal worden beheerd. **Microsoft** Voor organisaties die Microsoft 365 of on-premises Exchange Server gebruiken, hangt de beste optie af van zowel de omgeving als hoe de agenda-integratie is geconfigureerd. De Zoom voor Outlook-invoegtoepassing (Toevoegen) is de voorkeursoptie voor Microsoft 365-omgevingen — of u nu de desktop-, web- of mobiele versies van Outlook gebruikt. De invoegtoepassing vereist Outlook voor Microsoft 365, Outlook 2013 of later voor Windows, of Outlook 2016 of later voor Mac. Bi-Directionele agenda Synchroniseren zorgt voor naadloze agenda-updates en is Standaard ingeschakeld wanneer agenda's worden geïntegreerd. Dit stelt Zoom in staat om wijzigingen die in Outlook-agenda-Evenementen worden aangebracht—zoals verplaatste tijden of annuleringen—automatisch weer te geven, zonder dat gebruikers vergaderingen handmatig via de invoegtoepassing hoeven bij te werken of te verwijderen. Dit is vooral belangrijk omdat Zoom-vergaderingslinks kunnen verlopen als wijzigingen niet worden vastgelegd, vooral wanneer een vergadering meer dan 30 dagen na de oorspronkelijke datum wordt verplaatst. Vergader-ID's verlopen doorgaans na 30 dagen, tenzij ze deel uitmaken van een terugkerende reeks. De moderne JavaScript API (v1.8), die gebeurtenisgebaseerde automatisering zoals OnAppointmentSend aandrijft, wordt niet ondersteund door de volgende omgevingen en applicaties: * Exchange Server-omgevingen on-premises * Klassieke Outlook verbonden met M365 * Mobiele Outlook op iOS en Android Daardoor kan Zoom in deze configuraties vergaderingen niet automatisch detecteren of bijwerken via de invoegtoepassing. Zonder Bi-Directional Synchroniseren of op API gebaseerde automatisering is het mogelijk dat zelfs terugkerende vergaderingen wijzigingen niet weergeven, wat leidt tot verlopen of ongeldige Zoom-links. De Zoom Outlook-invoegtoepassing wordt alleen ondersteund op Windows-systemen. Deze biedt verbeterde synchronisatie van vergaderingen via directe Integratie(s) met de Zoom Workplace app, waarbij Microsoft API-beperkingen worden omzeild. Hoewel deze wordt aanbevolen voor Windows-systemen zonder Bi-Directional Synchroniseren, heeft deze enkele belangrijke beperkingen: * Vereist door IT beheerde MSI-updates * Langzamere Planning van vergaderingen * Geen ondersteuning voor macOS of mobiel ### Zoom Rooms De agenda-Integratie(s) van Zoom Rooms wordt onafhankelijk uitgevoerd van de Integratie(s) van de desktop- of mobiele client van de gebruiker. Na de configuratie verschijnen agenda-afspraken op Zoom Rooms-schermen, waaronder televisieschermen, Planning-interfaces en bedieningspanelen. Met één druk op de Controller van de ruimte kunnen gebruikers vergaderingen starten of eraan Deelnemen. #### Overzicht van de configuratie De agenda-Integratie(s) van Zoom Rooms omvat twee verschillende configuratielagen. De eerste laag is vereist, ongeacht welke authenticatiemethode u Selecteer. **Laag 1: configuratie van de Exchange-resourcepostbus (vereist voor alle methoden)** Voordat authenticatie wordt geconfigureerd, moeten beheerders Exchange Online-resourcepostbussen instellen voor elke Zoom Room. Dit omvat het configureren van de resourcepostbus in Exchange Online en het bijwerken van regels voor agenda-verwerking via Exchange Online PowerShell. Standaard stelt Exchange Online verschillende eigenschappen voor agenda-verwerking in op `Waar`waardoor Exchange details van de vergadering — zoals de onderwerpregel, informatie over de organisator en opmerkingen — uit agenda-items op resourcepostbussen verwijdert. Zoom Rooms moeten deze details behouden om zinvolle Evenement-informatie weer te geven op kamerschermen en controllers. Beheerders moeten de volgende eigenschappen voor agenda-verwerking bijwerken op `Onwaar` voor elke Zoom Room-resourcepostbus met behulp van de `Set-AgendaProcessing` cmdlet: * `VerwijderOnderwerp` * `VoegOrganisatorToeAanOnderwerp` * `VerwijderOpmerkingen` * `VerwijderPrivéEigenschap` Deze configuratie moet voor elke resource-mailbox worden herhaald. Voor de volledige PowerShell-procedure, inclusief validatiestappen, zie het Zoom-ondersteuning-artikel [Zoom Rooms instellen met Office 365](https://support.zoom.com/hc/en/article?id=zm_kb\&sysparm_article=KB0063474\&DeviceId=70283b61-c13a-475f-ab4d-4a89b1632c1b\&SessionId=1782321876035).Deze laag is vereist, ongeacht welke authenticatiemethode u in Laag 2 Selecteer. **Laag 2: authenticatiemethode-selectie** Nadat de resource-mailbox is geconfigureerd, Selecteer beheerders een authenticatiemethode om toegang tot agenda-gegevens voor Zoom Rooms Inschakelen: {% stepper %} {% step %} *Applicatiemachtigingen (Microsoft Graph API)* * **AANBEVOLEN**: Deze methode gebruikt de OAuth 2.0-clientcredentialsflow via een Azure-appRegistratie met toestemming van de beheerder. Hiervoor is geen speciaal serviceaccount nodig. {% endstep %} {% step %} *Volledige gedelegeerde toegang (Microsoft Graph API)* * Deze methode gebruikt de autorisatiecodestroom van OAuth 2.0 met gedelegeerde machtigingen voor het postvak. Hiervoor is een speciaal serviceaccount nodig en meer inspanning voor de eerste configuratie en het onderhoud. {% endstep %} {% endstepper %} Zoom raadt Microsoft Graph API met machtigingen voor de applicatie aan als de standaard Integratie(s)-methode. Deze aanbeveling sluit aan bij het plan van Microsoft om Exchange Web Services (EWS)-protocollen te verwijderen. De Graph API-methode biedt de meest stabiele verbinding tussen Zoom Rooms en Microsoft 365-agenda's. {% hint style="info" %} Organisaties die vergaderzaal-systemen van derden gebruiken (zoals Cisco, Poly en Lifesize) moeten via de Zoom Enhanced API Connector extra stappen uitvoeren om te zorgen voor de juiste agenda- en vergaderingfuncties. Raadpleeg ons document M365 Calendaring Field Guide voor meer informatie over het configureren van agenda-toegang voor Zoom Rooms. {% endhint %} #### Welke methoden kan ik gebruiken om toegang tot de postvakken van vergaderzalen te verlenen? De agenda-Integratie(s) van Zoom Rooms is afhankelijk van de Microsoft Graph API (MGAPI). Microsoft is begonnen [met het geleidelijk uitfaseren van de methoden van Exchange Web Services (EWS)](https://techcommunity.microsoft.com/blog/exchange/retirement-of-exchange-web-services-in-exchange-online/3924440) die eerder beschikbaar waren om Microsoft 365-gegevens te verbinden met Zoom-diensten. Zoom beschouwt deze EWS-methoden als verouderde opties. Google werkruimte heeft slechts één methode om Toestemming toe te passen. #### Welke Toestemming is vereist voor het service account? De specifieke Toestemming varieert afhankelijk van de geselecteerde methode. Elke optie en de vereiste Toestemming worden hieronder in de tabel beschreven: | Provider | Methode | Vereiste Toestemming | | --------------------------------------- | ---------------------------------------------------- | ------------------------------------------------------- | | Microsoft 365/Microsoft Exchange Server | Applicatiemachtigingen (Microsoft Graph API) | Beheerder account: Organisatiebeheer en ontvangerbeheer | | Microsoft 365/Microsoft Exchange Server | Volledige gedelegeerde toegang (Microsoft Graph API) | Verstuur als Volledige Access | | Google Werkruimte | - | Wijzigingen aanbrengen en delen beheren | {% hint style="info" %} **Aanbeveling van Zoom** Zoom raadt aan dat agenda-Integratie(s) de methode met machtigingen voor applicatie gebruiken. Deze configuratie vereist minder inspanning van de beheerder en vereist geen speciaal service account. Het is ook de door Microsoft aanbevolen aanpak voor Onderneming-applicaties die als achtergrondservices worden uitgevoerd. {% endhint %} ### Verbeterde API Connector De agenda-Integratie(s) voor op standaarden gebaseerde H.323- en SIP-kamersystemen via de Verbeterde API Connector (uitgebracht begin 2021) wordt onafhankelijk uitgevoerd van de configuratie van de gebruikerclient en Zoom Rooms. De methodologie en machtigingen van het service account zijn identiek aan het gedeelte over Zoom Rooms dat eerder is behandeld. #### Wat is er anders aan de gegevensstroom van de Verbeterde API Connector? Kamersystemen die via de Verbeterde API Connector zijn verbonden, zullen niet rechtstreeks contactpersoon hebben met aanbieders van agendering, wat verschilt van de verbindingsstromen van de Zoom-client en Zoom Room. De Zoom-webservice fungeert als een client voor deze systemen en zal agenderingsgegevens rechtstreeks naar de eindpunten pushen, met uitzondering van Poly Apparaat(en). Poly Apparaat(en) zullen eerst de Zoom-webservice opvragen voor agenderingsupdates, die vervolgens agenderingsgegevens naar het Apparaat verzendt. #### Hoeveel dagen aan agenda-items worden opgehaald? De Verbeterde API Connector haalt gegevens van de aanstaande vergadering op voor de Volgende 30 dagen en verwijdert voltooide vergadering(en) na 30 dagen uit de opslag. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://library.zoom.com/technical-library/nl/beheerdershoek/third-party-integrations/zoom-calendaring-integration-explainer/zoom-calendaring-endpoints.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.