# serverFunction

{% embed url="<https://youtu.be/9arAy_c2uI0>" %}

### Parameters

* functionName - the configured name of the function in App\_ServerSideFunction
* functionsParameters - (optional) json object with function parameters. The will be available in the function under body.parameters
* options - (optional) See examples. You can use the options to get the payload of the request or a postman example, instead of calling the function. Can be used to debug a function on your local machine

### Example Usages

To call a function and get the response object:

```javascript
let functionResponse = brixxApi.serverFunction("myFunction", {
   name: "Hallo"
});
console.log(functionResponse.functionResult);
```

\
To get an example payload based on the current app state:

```javascript
let functionResponse = brixxApi.serverFunction("myFunction", {
   name: "Hallo"
},{
   payload: true
});
console.log(functionResponse.functionResult);
```

To get an example postman collection including the payload of the current app:

```javascript
let functionResponse = brixxApi.serverFunction("myFunction", {
   name: "Hallo"
},{
   postman: true
});
console.log(functionResponse.functionResult);
```

#### To define your own server functions please check [Server Api Reference](/brixxbox-documentation/server-api-reference.md)


---

# Agent Instructions: 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:

```
GET https://brixxbox.gitbook.io/brixxbox-documentation/client-api-reference/functions/serverfunction.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.