Build Voxity AI Scenarios

After connecting the app, you can perform the following actions:

Triggers

---

Watch Opportunities

Triggers when specified opportunity events occur.

Webhook name	Enter a name for the webhook.
Connection	Establish a connection to your Voxity agent.
Secret Key	Enter a secret key to validate incoming events.
Events	Enter the opportunity events you want to watch. For a list of supported events, see Types of events.

Watch Calls

Triggers when specified call events occur.

Webhook name	Enter a name for the webhook.
Connection	Establish a connection to your Voxity agent.
Secret Key	Enter a secret key to validate incoming events.
Events	Enter the call events you want to watch. For a list of supported events, see Types of events.

Actions

---

Get a Customer

Retrieve a customer object.

Connection	Establish a connection to your Voxity's agent.
Customer ID	Enter the Customer ID whose details you want to retrieve.

Call a LLM Responder

Invoke a LLM based on the configuration defined in the Responder.

Connection	Establish a connection to your Voxity's agent.
Responder ID	Enter the Responder ID to be called.
Input	This parameter allows passing a JSON string object to the LLM prompt. This object includes all the properties required to invoke a Responder. See the API Invoke Responder documentation.

Send a SMS

Send an SMS to a customer.

Connection	Establish a connection to your Voxity's agent.
Customer ID	Enter the Customer ID for sending the SMS.
Message	Enter content of the SMS message.

Crete an Opportunity Note

Create a note on an opportunity.

Connection	Establish a connection to your Voxity's agent.
Customer ID	Enter the ID of the customer associated with the note.
Opportunity ID	Enter the ID of the opportunity associated with the note.
Content	Enter the content of the note.

Update an Opportunity

Updates the specified opportunity by setting the values of the parameters passed.

Connection	Establish a connection to your Voxity's agent.
Opportunity ID	Enter the ID of the opportunity whose details you want to update.
Name	Enter a name for the opportunity.
Owner ID	Select the ID of the user who will own the opportunity.
Pipeline ID	Select the pipeline to which the opportunity will belongs.
Stage ID	Select the appropriate stage within the pipeline.
Score	Enter a numerical score for the opportunity.
Amount	Enter a monetary value associated with the opportunity.

List Opportunities

Retrieves a list of opportunities.

Connection	Establish a connection to your Voxity's agent.
Pipeline ID	Select the pipeline whose opportunities you want to list.
Stage ID	Select the appropriate stage within the pipeline.
Limit	Set the maximum number of opportunities to return during one scenario execution cycle.

List Stages

Retrieves stages by applying Pipeline and Stage filters.

Connection	Establish a connection to your Voxity's agent.
Pipeline ID	Select the pipeline whose stages you want to list.
Stage ID	Filter by the appropriate stages within the pipeline.

Call a Customer

Place an outbound call to a customer.

Connection	Establish a connection to your Voxity's agent.
Customer ID	Select the customer to call.
Persona ID	Select the AI persona for the call.

Others

---

Make an API Call

Performs an arbitrary authorized API call.

Connection	Establish a connection to your Voxity's agent.
API Version	Enter the version of the API. (e.g. v1)
URL	Enter a path relative to Voxity API endpoint. For example: /customers For the list of available endpoints, refer to the Voxity API documentation.
Method	Select the HTTP method you want to use: GET: to retrieve information for an entry. POST: to create a new entry. PUT: to update/replace an existing entry. PATCH: to make a partial entry update. DELETE: to delete an entry.
Headers	Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String	Enter the request query string.
Body	Enter the body content for your API call.

Watch Events

Triggers when a given event occur.

Webhook name	Enter a name for the webhook.
Connection	Establish a connection to your Voxity agent.
API Version	Enter the version of the API. (e.g. v1)
Secret key	Enter a secret key to validate incoming events.
Events	Enter the events you want to watch. For a list of supported events, see Types of events.