Share via

Agent messaging endpoint

Important

You need to be part of the Frontier preview program to get early access to Microsoft Agent 365. Frontier connects you directly with Microsoft’s latest AI innovations. Frontier previews are subject to the existing preview terms of your customer agreements. As these features are still in development, their availability and capabilities may change over time.

The agent messaging endpoint is the endpoint where you send agentic notification messages to your agent.

Delete agent messaging endpoint

Use the a365 cleanup blueprint --endpoint-only command to delete the agent messaging endpoint entry. This command doesn't affect your agent code or the deployed endpoint. It only deletes the registration entry of this endpoint for your agent.

a365 cleanup blueprint --endpoint-only

Configure messaging endpoint in a365.config.json

Before setting the messaging endpoint, specify it in your a365.config.json configuration file. This file contains the core configuration for your agent deployment.

Add or update these messaging endpoint configuration properties:

{
  "messagingEndpoint": "https://your-endpoint-url.com/api/messages",
  "needDeployment": false,
  "deploymentProjectPath": "."
}

  • messagingEndpoint: Specify the exact endpoint URL where you can send messages to the agent.

  • needDeployment: Indicate to the CLI whether you want it to deploy your code to an Azure web app.

  • deploymentProjectPath: Deploy your agent code to the cloud. This property isn't relevant if your agent is already deployed and you don't need to deploy it again. Set deploymentProjectPath to . only if the agent code isn't located on your machine.

Configuration properties

Property Description Required Default Example
messagingEndpoint The URL where your agent receives messages Yes None https://your-app.azurewebsites.net/api/messages
needDeployment Whether CLI should deploy to Azure (true) or you're self-hosting (false) No true false for AWS/GCP/Dev Tunnels
deploymentProjectPath Path to your agent project directory for deployment and configuration updates No . ./my-agent or .

Endpoint configuration options

The messagingEndpoint value depends on your deployment scenario:

For Azure deployments (needDeployment: true):

  • Azure Web App: https://your-app-name.azurewebsites.net/api/messages

For non-Azure deployments (needDeployment: false):

  • AWS: https://your-api-gateway-url.amazonaws.com/api/messages
  • GCP: https://your-cloud-run-url.run.app/api/messages
  • Other cloud providers: Your custom endpoint URL

For local testing with Dev Tunnels (needDeployment: false):

  • Dev Tunnel URL: https://abc123xyz.devtunnels.ms:3978/api/messages

Important

  • When you deploy to Azure, set needDeployment to true. The CLI automatically handles deployment.
  • For AWS, GCP, or Dev Tunnels, set needDeployment to false to indicate you're managing deployment separately.
  • The deploymentProjectPath specifies where the CLI looks for project files and where it updates environment configuration, such as .env files.

Note

When using Dev Tunnels for local testing, update the messagingEndpoint in a365.config.json with your Dev Tunnel URL and set needDeployment to false before running the setup command. For more information, see testing with Dev Tunnels.

Set agent messaging endpoint

After updating your a365.config.json file, use this command to register the messaging endpoint with the Agent 365 service so that it can send notifications to your agent.

During local testing, you can set this endpoint to a Dev Tunnel endpoint before deploying the agent to the cloud. For more information, see testing with Dev Tunnels.

a365 setup blueprint --endpoint-only

Deployment of endpoint

If you don't already have your agent deployed to the cloud, learn how to deploy agent to Azure.

If you already have your agent deployed to the cloud, you can set the messaging endpoint as shown earlier.

Learn how to set the messaging endpoint on some other popular clouds:

  • Last updated on