Setting Server URLs
Learn about where you can set server URLs to handle call events.
Server URLs can be set at multiple levels in Vapi.
Server URLs can be set in multiple places in Vapi. Each level has a different priority.
The server URL with the highest priority for a relevant event will be the one that Vapi uses to send the event to.
Server URLs can be set at 4 levels in Vapi:
- Account-wide: you can set a server URL for your broader account
- Phone Number: server URLs can be attached to phone numbers themselves
- Assistant: assistants can be configured with a server URL
- Function: function calls themselves (under an assistant) can have a corresponding server URL
Setting Server URLs
Here’s a breakdown of where you can set server URLs in Vapi:
Organization
Organization
You can set an organization-wide server URL in the organization section of your dashboard.
Setting your organization-wide server URL.
If no other server URL is set, Vapi will use this one.
Phone Number
Phone Number
Phone numbers can have a server URL attached to them via the phone number API.
The server URL for phone numbers can be set 3 ways:
- At Time of Purchase: when you buy a number through Vapi
- At Import: when you import from Twilio or Vonage
- Via Update: you can update a number already in your account
The field phoneNumber.serverUrl will contain the server URL for the phone number.
Assistant
Assistant
Assistants themselves can have a server URL attached to them.
There are 2 ways this can be done:
In the Dashboard
In the Dashboard
If you go to the assistant section of your dashboard, in the “Advanced” tab you will see a setting to set the assistant’s server URL:
Setting server URL at the assistant level.
Via the API
Via the API
At assistant creation (or via an update) you can set the assistant’s server URL.
The server URL for an assistant is stored in the assistant.serverUrl field.
Function Call
Function Call
The most granular level server URLs can be set is at the function call level. This can also be done either in the dashboard, or via code.
In the Dashboard
In the Dashboard
In the assistant section of your dashboard, in the “Functions” tab you can add function calls & optionally give each a specific server URL:
Setting server URL at the function call level.
Via the API
Via the API
The server URL for a function call can be found on an assistant at assistant.model.functions[].serverUrl.
You can either set the URL for a function call at assistant creation, or in an assistant update.
URL Priority
Events are only sent/assigned to 1 server URL in the priority stack. Here’s the order of priority:
- Function: if a function call has a server URL, the function call event will be sent to that URL
- Assistant: assistant server URLs are the next highest priority
- Phone Number: if a phone number has a server URL, it will be used over the account-wide URL
- Account-wide: Default / “lowest” importance. It will be used if no other server URL is set.
You will most commonly set a server URL on your account, and/or on specific assistants.
Setting Server URLs
Learn about where you can set server URLs to handle call events.
Server URLs can be set at multiple levels in Vapi.
Server URLs can be set in multiple places in Vapi. Each level has a different priority.
The server URL with the highest priority for a relevant event will be the one that Vapi uses to send the event to.
Server URLs can be set at 4 levels in Vapi:
- Account-wide: you can set a server URL for your broader account
- Phone Number: server URLs can be attached to phone numbers themselves
- Assistant: assistants can be configured with a server URL
- Function: function calls themselves (under an assistant) can have a corresponding server URL
Setting Server URLs
Here’s a breakdown of where you can set server URLs in Vapi:
Organization
Organization
You can set an organization-wide server URL in the organization section of your dashboard.
Setting your organization-wide server URL.
If no other server URL is set, Vapi will use this one.
Phone Number
Phone Number
Phone numbers can have a server URL attached to them via the phone number API.
The server URL for phone numbers can be set 3 ways:
- At Time of Purchase: when you buy a number through Vapi
- At Import: when you import from Twilio or Vonage
- Via Update: you can update a number already in your account
The field phoneNumber.serverUrl will contain the server URL for the phone number.
Assistant
Assistant
Assistants themselves can have a server URL attached to them.
There are 2 ways this can be done:
In the Dashboard
In the Dashboard
If you go to the assistant section of your dashboard, in the “Advanced” tab you will see a setting to set the assistant’s server URL:
Setting server URL at the assistant level.
Via the API
Via the API
At assistant creation (or via an update) you can set the assistant’s server URL.
The server URL for an assistant is stored in the assistant.serverUrl field.
Function Call
Function Call
The most granular level server URLs can be set is at the function call level. This can also be done either in the dashboard, or via code.
In the Dashboard
In the Dashboard
In the assistant section of your dashboard, in the “Functions” tab you can add function calls & optionally give each a specific server URL:
Setting server URL at the function call level.
Via the API
Via the API
The server URL for a function call can be found on an assistant at assistant.model.functions[].serverUrl.
You can either set the URL for a function call at assistant creation, or in an assistant update.
URL Priority
Events are only sent/assigned to 1 server URL in the priority stack. Here’s the order of priority:
- Function: if a function call has a server URL, the function call event will be sent to that URL
- Assistant: assistant server URLs are the next highest priority
- Phone Number: if a phone number has a server URL, it will be used over the account-wide URL
- Account-wide: Default / “lowest” importance. It will be used if no other server URL is set.
You will most commonly set a server URL on your account, and/or on specific assistants.