​EnvoyAI API

Welcome to the EnvoyAI API documentation

Base URL https://www.tryenvoy.ai

Trigger API

This API allows you to trigger workflows in the Envoy staging environment. Use the /workflows/{workflowid}/trigger endpoint to start workflow runs programmatically.

​ Example Request

Headers:

Header
Value
Description

Authorization

Bearer <YOUR_API_KEY>

Required for authentication

Content-Type

application/json

Required for JSON payload

Copy

{
  "route_number": "12345",
  "phone_number": "+15551234567"
}

​Notes

  • Make sure you include a valid Bearer token in the request headers.

  • The workflowid parameter is required and must be a valid UUID.

  • Sends a request like Request JSON body: {"shipment_updates": "notes" } to your api

  • Responses include status and workflow_run_id on success.

Last updated