For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
HomeGet API key
DocumentationIntegrationsAPI Reference
DocumentationIntegrationsAPI Reference
  • API Reference
      • GETGet Webhook
      • POSTCreate Or Update Webhook
      • DELDelete Webhook
      • GETList Deliveries
      • GETDelivery Stats
      • GETAll Time Stats
      • POSTTest Webhook
LogoLogo
HomeGet API key
API Referencewebhooks

Test Webhook

POST
https://api.agentphone.ai/v1/webhooks/test
POST
/v1/webhooks/test
1const url = 'https://api.agentphone.ai/v1/webhooks/test';
2const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
3
4try {
5 const response = await fetch(url, options);
6 const data = await response.json();
7 console.log(data);
8} catch (error) {
9 console.error(error);
10}

Send a test webhook to verify the endpoint is working.

Sends a fake message payload to the configured URL. Pass ?agentId=… to control which agent appears in the payload; otherwise the first agent in the account is used.

Was this page helpful?
Previous

Get Agent Webhook

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

agentIdstring or nullOptional
Agent ID to include in the test payload

Response

Successful Response

Errors

422
Unprocessable Entity Error