How to call an external API from Workspace Studio

A Google Workspace Studio workflow might need data from outside Gmail, Drive, or Chat: an order status, a number from a database, or a response from an internal tool. To retrieve this data or send information to another service, you can add the step Send a webhookThis makes an HTTP request to the address of an API you have specified.

You don't need to configure the Gemini function call to make that request. In Workspace Studio, the flow executes the webhook step and receives the response. Then, if you find it useful, you can pass that response to another step to summarize it, extract data, or communicate the result.

What you need before connecting to an API

The first step is to verify that your organization can use webhooks. The function is located in limited preview and is disabled by default. An administrator must log in. Apps > Google Workspace > Workspace Studio > Webhook Settings and enable it for the corresponding organizational unit.

In some editions, the administrator can also limit connections to one list of allowed domains and URLsIf the step appears in Studio but fails to communicate with your API, verify that the destination address is authorized. Also, by default, actions involving webhooks require the user to review and confirm the step before execution.

From the external service, you need to know its URL, the HTTP methods it supports, and the data format it expects. Also, check how it authenticates: a public read-only API has different requirements than a private API that requires tokens or special headers.

How to call an API from Workspace Studio step by step

Enter studio.workspace.google.com and create a workflow with the trigger you need. For example, you can start it when an email arrives that meets certain conditions. Then, follow these steps:

1. Press Add step and select Send a webhook.
2. Enter the Full URL of the API, including the prefix https://The address must be fixed: this field does not support flow variables.
3. Select the HTTP method. GET It is used to query data; POSTto send them or create a record. They are also available PUT, PATCH and DELETE.
4. If the API requires a body, write it in the content field or payloadGoogle recommends using JSON when the receiving service expects it.
5. Make a test executionCheck the result and activate the flow once you have verified that it works.

Keep in mind that the test perform the actionIf you configure a POST to create a record or a DELETE to delete it, first use a test environment or data that you can modify without problems.

Example: sending a notification to an external tool

Imagine your team has an API that creates alerts in https://api.ejemplo.com/v1/avisosThis address is illustrativeYou'll need to replace it with the one from your service. If its documentation indicates that it accepts POST and a JSON body, you could configure the step with content like {"tipo":"nuevo_correo","origen":"Workspace Studio"}.

You can also insert a flow variable In the body, for example, to include the subject of the email that triggered it. Do this from Studio's variable selector and check the result: if the inserted text contains quotation marks or other special characters, it could leave the JSON malformed. Variables can be used in the content, but not in the URL field.

If you need to retrieve data, choose GET and enter a fixed URL that already contains the necessary parameters. Workspace Studio will ignore any content you've written in the body of a GET request.

What to do with the API response

The webhook step leaves the service response as text in a variable available for subsequent steps. You can use it to send a notification, write a summary, or ask an AI step to extract specific data.

For example, if the API returns the status of an order, the next step can communicate that status to the team. Explicitly select the variable containing the response: subsequent steps don't automatically receive everything that happened earlier in the flow. It's advisable to test the returned content before writing instructions that depend on it.

If the API requires authentication or more complex logic

The documented basic configuration for Send a webhook It includes the URL, the method, and an optional body. If your integration needs to obtain an OAuth token, construct a URL with variable parameters, add specific headers, or transform a response before proceeding, check if this step covers those requirements.

When that falls short, one option is to develop a Custom step for Workspace Studio via a plugin. In a Google Apps Script implementation, the service UrlFetchApp It allows you to make requests to external APIs and process JSON responses. This solution requires development and proper permission configuration; it's not necessary for simple requests that the native step can already handle.

Avoid pasting private keys into visible fields of the flow or embedding them in a shared URL. Before sending data from Gmail, Chat, or Calendar, verify what information the external service will receive and whether it is authorized to process it.

How to locate errors in a webhook

If the connection fails, open the tab Activity of the flow. There you can view the full error and the response sent by the destination server. This information helps distinguish between a Studio configuration problem and a request rejected by the API.

• The step does not appear: Check with your administrator if webhooks are enabled for your organizational unit.
• The URL is blocked: Check the list of allowed addresses, if your edition uses that restriction.
• Error 400: check the body format and the fields required by the API.
• Error 401 or 403: Review the permissions and authentication method required by the service.
• Error 429: Check if you have exceeded the request limit for the target API.
• Error 500: Check the status and records of the service receiving the request.

Also keep in mind the general limitations of Workspace Studio: it currently supports up to 25 flows per user y 20 steps per flowIn addition, there is a combined execution limit that resets every 24 hours. If multiple flows stop running, review their activity before attributing the failure to the API.

For most simple HTTP connections, the process is straightforward: enable the webhook, configure a fixed URL and the correct method, test the request, and use the response in subsequent steps. If the integration requires advanced authentication or transforming data through code, then it makes sense to prepare a custom step.