extended-salmon•16mo ago

Function Call Properties and Payload

I am creating a custom function to be executed in Make for my VAPI assistant. I noticed that there is a property option under the description of the function. What is a custom function property and is it the same as the parameters for the custom function? Also I am trying to send a test payload to the webhook in Make. What is this supposed to look like, is there an request payload template I can use?

4 Replies

Ask Inkeep•16mo ago

Hi @Clutch, I'm an AI assistant for Vapi. I'll analyze available sources and get back to you shortly. ----------------------------- While I generate an answer, here are some sources that might be helpful: * Tools Calling * Function Calling * Server URLs * Dynamic Variables ----------------------------- Answer In the context of Vapi, a custom function property typically refers to the details that define the function's behavior and operational parameters. This includes the function's name, description, and parameters. The parameters specifically are the data that the function expects to receive, such as input values required to execute the function (1) . As for your second question regarding the payload for a webhook in Make, the payload typically follows the structure defined when setting up the function in your Vapi assistant. Here is an example modification of a payload, which you can adjust according to your specific requirements:

{
  "type": "function",
  "messages": [
    {
      "type": "request-start",
      "content": "Initiating function call. Please wait..."
    },
    {
      "type": "request-complete",
      "content": "The function call is complete."
    },
    {
      "type": "request-failed",
      "content": "The function call failed."
    },
    {
      "type": "request-response-delayed",
      "content": "The response from the function is delayed.",
      "timingMilliseconds": 2000
    }
  ],
  "function": {
    "name": "your_custom_function",
    "parameters": {
      "type": "object",
      "properties": {
        "parameter1": {
          "type": "string"
        },
        "parameter2": {
          "type": "number"
        }
      }
    },
    "description": "Description of your custom function."
  },
  "async": false,
  "server": {
    "url": "https://your-server-url.com/path"
  }
}

{
  "type": "function",
  "messages": [
    {
      "type": "request-start",
      "content": "Initiating function call. Please wait..."
    },
    {
      "type": "request-complete",
      "content": "The function call is complete."
    },
    {
      "type": "request-failed",
      "content": "The function call failed."
    },
    {
      "type": "request-response-delayed",
      "content": "The response from the function is delayed.",
      "timingMilliseconds": 2000
    }
  ],
  "function": {
    "name": "your_custom_function",
    "parameters": {
      "type": "object",
      "properties": {
        "parameter1": {
          "type": "string"
        },
        "parameter2": {
          "type": "number"
        }
      }
    },
    "description": "Description of your custom function."
  },
  "async": false,
  "server": {
    "url": "https://your-server-url.com/path"
  }
}

Ask Inkeep•16mo ago

This template includes the function type, messages to inform the user about the status of the function call, details about the function itself, and the server endpoint. Make sure to replace "your_custom_function", the parameter structure, and the server URL with the actual details specific to your function in Make.

Sources [1] Tools Calling

wee-brown•16mo ago

pls provide the latest call_id

extended-salmonOP•16mo ago

I got it resolved, good now, thanks

Function Call Properties and Payload

Did you find this page helpful?