Custom use cases
Trigger outbound call
Trigger an outbound call. When finished, the results will be sent to your server URL. Agent ID can be found in the UI when creating or editing a custom use case under “API trigger”. Read more about how it works.
POST
Authorizations
An authentication token that identifies the organization associated with the event. You can reach out to FleetWorks team to request a token.
Path Parameters
Body
application/json
Phone number in E.164 format (e.g. +1XXXXXXXXXX for US numbers). Must include country code with + prefix.
Example:
"+15551234567"
Dynamic variables to be injected into the prompt.
Example:
{
"loadId": "123456",
"pickupLocation": "Chicago, IL",
"deliveryLocation": "New York, NY",
"rate": "2500"
}
Response
200
application/json
Success
Example:
true