HTTP Triggers

You can invoke Cloud Functions with an HTTP request using the POST, PUT, GET, DELETE, and OPTIONS HTTP methods. To create an HTTP endpoint for your function, specify --trigger-http as the trigger type when deploying your function. From the caller's perspective, HTTP invocations are synchronous, meaning that the result of the function execution will be returned in the response to the HTTP request.

Note: Functions with HTTP(S) triggers are not supported in projects whose IDs contain a colon.

For example, the following gcloud command deploys a function to the Node.js 8 runtime that will be triggered by HTTP requests:

gcloud functions deploy FUNCTION_NAME --runtime nodejs8 --trigger-http

You can use the commonly available cURL command-line utility to invoke HTTP functions. The following cURL command makes a POST request with some data to the URL of a deployed HTTP function:

curl -X POST "https://YOUR_REGION-YOUR_PROJECT_ID.cloudfunctions.net/FUNCTION_NAME" -H "Content-Type:application/json" --data '{"name":"Keyboard Cat"}'

where

• YOUR_REGION is the region where your function is deployed,
• YOUR_PROJECT_ID is your Google Cloud Platform project ID, and
• FUNCTION_NAME is the name of the HTTP function you deployed.

The trigger URL for an HTTP function can be seen after the function is deployed, or queried at any time using the gcloud functions describe command.

You can also trigger your HTTP functions directly through the gcloud tool. The following command calls a function and sends it some data in the body of an HTTP POST request:

gcloud functions call FUNCTION_NAME --data '{"name":"Keyboard Cat"}'

Code sample

Node.js

functions/helloworld/index.js

View on GitHub Feedback

const escapeHtml = require('escape-html');

/**
 * HTTP Cloud Function.
 *
 * @param {Object} req Cloud Function request context.
 *                     More info: https://expressjs.com/en/api.html#req
 * @param {Object} res Cloud Function response context.
 *                     More info: https://expressjs.com/en/api.html#res
 */
exports.helloHttp = (req, res) => {
  res.send(`Hello ${escapeHtml(req.query.name || req.body.name || 'World')}!`);
};

Python

functions/helloworld/main.py

View on GitHub Feedback

from flask import escape

def hello_http(request):
    """HTTP Cloud Function.
    Args:
        request (flask.Request): The request object.
        <http://flask.pocoo.org/docs/1.0/api/#flask.Request>
    Returns:
        The response text, or any set of values that can be turned into a
        Response object using `make_response`
        <http://flask.pocoo.org/docs/1.0/api/#flask.Flask.make_response>.
    """
    request_json = request.get_json(silent=True)
    request_args = request.args

    if request_json and 'name' in request_json:
        name = request_json['name']
    elif request_args and 'name' in request_args:
        name = request_args['name']
    else:
        name = 'World'
    return 'Hello {}!'.format(escape(name))

Go

functions/helloworld/hello_http.go

View on GitHub Feedback

// Package helloworld provides a set of Cloud Functions samples.
package helloworld

import (
	"encoding/json"
	"fmt"
	"html"
	"net/http"
)

// HelloHTTP is an HTTP Cloud Function with a request parameter.
func HelloHTTP(w http.ResponseWriter, r *http.Request) {
	var d struct {
		Name string `json:"name"`
	}
	if err := json.NewDecoder(r.Body).Decode(&d); err != nil {
		fmt.Fprint(w, "Hello, World!")
		return
	}
	if d.Name == "" {
		fmt.Fprint(w, "Hello, World!")
		return
	}
	fmt.Fprintf(w, "Hello, %s!", html.EscapeString(d.Name))
}

Event structure

HTTP-triggered functions receive events via language-idiomatic HTTP frameworks. See the code samples above for more information.

Next steps

See the HTTP Tutorial for an example of how to implement an HTTP function, or HTTP Functions to learn more about writing HTTP functions.