Hoe roep ik een externe API aan vanuit Workspace Studio?

Een workflow in Google Workspace Studio heeft mogelijk gegevens nodig van buiten Gmail, Drive of Chat: een orderstatus, een getal uit een database of een reactie van een interne tool. Om deze gegevens op te halen of informatie naar een andere service te verzenden, kunt u de volgende stap toevoegen. Verzend een webhookHiermee wordt een HTTP-verzoek verzonden naar het adres van een API die u hebt opgegeven.

Je hoeft de Gemini-functieaanroep niet te configureren om dat verzoek te doen. In Workspace Studio voert de workflow de webhook-stap uit en ontvangt het antwoord. Vervolgens kun je, als je dat nuttig vindt, dat antwoord doorgeven aan een andere stap om het samen te vatten, gegevens te extraheren of het resultaat te communiceren.

Wat je nodig hebt voordat je verbinding maakt met een API

De eerste stap is controleren of uw organisatie webhooks kan gebruiken. De functie bevindt zich in beperkte preview en is standaard uitgeschakeld. Een beheerder moet inloggen. Apps > Google Workspace > Workspace Studio > Webhook-instellingen en het inschakelen voor de betreffende organisatie-eenheid.

In sommige edities kan de beheerder het aantal verbindingen ook beperken tot één. Lijst met toegestane domeinen en URL'sAls de stap wel in Studio verschijnt, maar niet met uw API communiceert, controleer dan of het bestemmingsadres geautoriseerd is. Standaard vereisen acties met webhooks bovendien dat de gebruiker de stap controleert en bevestigt voordat deze wordt uitgevoerd.

Van de externe service moet je de URL, de ondersteunde HTTP-methoden en het verwachte gegevensformaat weten. Controleer ook hoe de authenticatie verloopt: een openbare, alleen-lezen API heeft andere vereisten dan een privé-API die tokens of speciale headers vereist.

Stapsgewijze handleiding voor het aanroepen van een API vanuit Workspace Studio

Binnenkomen studio.workspace.google.com Maak een workflow aan met de gewenste trigger. Je kunt de workflow bijvoorbeeld starten wanneer een e-mail binnenkomt die aan bepaalde voorwaarden voldoet. Volg daarna deze stappen:

1. Pers Voeg stap toe en selecteer Verzend een webhook.
2. Ga naar de Volledige URL van de API, inclusief het voorvoegsel https://Het adres moet vast zijn: dit veld ondersteunt geen stroomvariabelen.
3. Selecteer de HTTP-methode. KRIJGEN Het wordt gebruikt om gegevens op te vragen; NAom ze te verzenden of een dossier aan te maken. Ze zijn ook beschikbaar. PLAATSEN, PATCHEN en VERWIJDEREN.
4. Als de API een body vereist, schrijf deze dan in het contentveld of nuttige ladingGoogle raadt aan om JSON te gebruiken wanneer de ontvangende service dit verwacht.
5. Maak een testuitvoeringControleer het resultaat en activeer de workflow zodra je hebt geverifieerd dat deze werkt.

Houd er rekening mee dat de test voer de actie uitAls u een POST-verzoek configureert om een ​​record aan te maken of een DELETE-verzoek om het te verwijderen, gebruik dan eerst een testomgeving of gegevens die u zonder problemen kunt wijzigen.

Voorbeeld: een melding naar een extern programma sturen.

Stel je voor dat je team een ​​API heeft die waarschuwingen genereert in... https://api.ejemplo.com/v1/avisosDit adres is illustratiefJe moet het vervangen door het exemplaar van je service. Als de documentatie aangeeft dat het POST-verzoeken en een JSON-body accepteert, kun je de stap configureren met inhoud zoals: {"tipo":"nuevo_correo","origen":"Workspace Studio"}.

Je kunt ook een invoegen stroomvariabele In de body kun je bijvoorbeeld het onderwerp van de e-mail opnemen die de actie heeft geactiveerd. Doe dit via de variabelekiezer van Studio en controleer het resultaat: als de ingevoegde tekst aanhalingstekens of andere speciale tekens bevat, kan dit leiden tot een onjuiste JSON-structuur. Variabelen kunnen wel in de content worden gebruikt, maar niet in het URL-veld.

Als u gegevens wilt ophalen, kiest u GET en voert u een vaste URL in die al de benodigde parameters bevat. Workspace Studio negeert alle inhoud die u in de body van een GET-verzoek hebt geschreven.

Wat te doen met het API-antwoord?

De webhook-stap laat de servicereactie als tekst in een variabele die beschikbaar is voor volgende stappen. Je kunt deze gebruiken om een ​​melding te versturen, een samenvatting te schrijven of een AI-stap te vragen specifieke gegevens te verzamelen.

Als de API bijvoorbeeld de status van een bestelling retourneert, kan de volgende stap die status aan het team doorgeven. Selecteer expliciet de variabele die het antwoord bevat: volgende stappen ontvangen niet automatisch alles wat er eerder in het proces is gebeurd. Het is raadzaam om de geretourneerde inhoud te testen voordat u instructies schrijft die ervan afhankelijk zijn.

Als de API authenticatie of complexere logica vereist.

De gedocumenteerde basisconfiguratie voor Verzend een webhook Het bevat de URL, de methode en een optionele body. Als uw integratie een OAuth-token moet verkrijgen, een URL met variabele parameters moet samenstellen, specifieke headers moet toevoegen of een respons moet transformeren voordat verder wordt gegaan, controleer dan of deze stap aan die vereisten voldoet.

Als dat niet voldoende blijkt, is een van de opties om een Aangepaste stap voor Workspace Studio via een plug-in. In een Google Apps Script-implementatie is de service UrlFetchApp Hiermee kunt u verzoeken naar externe API's sturen en JSON-reacties verwerken. Deze oplossing vereist ontwikkeling en de juiste configuratie van machtigingen; het is niet nodig voor eenvoudige verzoeken die de native stap al kan afhandelen.

Vermijd het plakken van privésleutels in zichtbare velden van de workflow of het opnemen ervan in een gedeelde URL. Controleer voordat u gegevens vanuit Gmail, Chat of Agenda verzendt, welke informatie de externe service ontvangt en of deze gemachtigd is om deze te verwerken.

Hoe vind ik fouten in een webhook?

Als de verbinding mislukt, open dan het tabblad. Activiteit van de workflow. Daar kunt u de volledige foutmelding en het antwoord van de doelserver zien. Deze informatie helpt onderscheid te maken tussen een configuratieprobleem in Studio en een verzoek dat door de API is afgewezen.

• De stap verschijnt niet: Neem contact op met uw beheerder om te controleren of webhooks zijn ingeschakeld voor uw organisatie-eenheid.
• De URL is geblokkeerd: Controleer de lijst met toegestane adressen, als uw editie die beperking hanteert.
• Fout 400: Controleer de body-indeling en de velden die de API vereist.
• Fout 401 of 403: Controleer de machtigingen en de authenticatiemethode die de service vereist.
• Fout 429: Controleer of u de aanvraaglimiet voor de betreffende API hebt overschreden.
• Fout 500: Controleer de status en gegevens van de dienst die het verzoek ontvangt.

Houd ook rekening met de algemene beperkingen van Workspace Studio: het ondersteunt momenteel maximaal 25 flows per gebruiker y 20 stappen per stroomDaarnaast geldt er een gecombineerde uitvoeringslimiet die elke 24 uur wordt gereset. Als meerdere processen stoppen met werken, controleer dan eerst hun activiteit voordat u de storing aan de API toeschrijft.

Voor de meeste eenvoudige HTTP-verbindingen is het proces rechttoe rechtaan: schakel de webhook in, configureer een vaste URL en de juiste methode, test het verzoek en gebruik het antwoord in de volgende stappen. Als de integratie geavanceerde authenticatie vereist of gegevens via code moet transformeren, is het verstandig om een ​​aangepaste stap voor te bereiden.