use( )

A function that responds to requests made with any HTTP method.

Description

Requests made with any of the GET, POST, PUT, DELETE, or OPTIONS HTTP methods will be routed to this function unless another function is defined specifically for the request's HTTP method.

For example, if you create functions named get_myFunction and use_myFunction, GET calls to myFunction will be handled by get_myFunction, while POST, PUT, DELETE, and OPTIONS calls will be handled by use_myFunction.

The use() function is not a function that you call from your code. You define the function in a file named http-functions.js in your site's Backend section. The function is called when your users make HTTP requests using the associated URLs as described below.

All GET, POST, PUT, DELETE, and OPTIONS HTTP requests with the following URL will be routed to this function unless another function is defined specifically for the request's HTTP method:

Premium sites:

https://www.{user_domain}/_functions/<functionName>

Copy Code

Free sites:

https://{user_name}.wixsite.com/{site_name}/_functions/<functionName>

Copy Code

Respond to the request by returning a WixHttpFunctionResponse object you create using one of the response(), ok(), created(), notFound(), serverError(), badRequest(), or forbidden() functions.

Note: You must publish your site at least once before using both the testing and production endpoints. When you make changes to production endpoints you must publish your site for them to take effect. Testing endpoints will use the latest code in the editor.

Syntax

function use(request: wixhttpfunctionrequest-obj): WixHttpFunctionResponse

use Parameters

NAME

TYPE

DESCRIPTION

request

wixhttpfunctionrequest-obj

The request object.

Returns

Return Type:

WixHttpFunctionResponse

Was this helpful?

Create a catchall HTTP function

This example creates a catchall HTTP function named myFunction.

Copy Code

1// In http-functions.js
2
3import {ok} from 'wix-http-functions';
4
5export function use_myFunction(request) {
6
7  const method = request.method;
8
9  // ...
10
11  return ok();
12}
13