POST
/
to_your_webhook_url
curl --request POST \
  --url https://app.phonely.ai/api/to_your_webhook_url
{
  "agentName": "<string>",
  "mentionedEmail": "<string>",
  "unansweredQuestions": [
    "<string>"
  ],
  "actionItems": [
    "<string>"
  ],
  "followUpReason": "<string>",
  "followUp": "<string>",
  "recordingUrl": "<string>",
  "dashboardUrl": "<string>",
  "purpose": "<string>",
  "sentiment": "<string>",
  "transcriptText": "<string>",
  "transcript": [
    {
      "content": "<string>",
      "role": "<string>"
    }
  ],
  "mentionedDate": "<string>",
  "businessPhoneNumber": "<string>",
  "keyPoints": [
    "<string>"
  ],
  "topic": "<string>",
  "longSummary": "<string>",
  "callId": "<string>",
  "ai_success": "<string>",
  "customerPhoneNumber": "<string>",
  "callStarted": "2023-11-07T05:31:56Z",
  "callEnded": "2023-11-07T05:31:56Z",
  "duration": 123,
  "callerName": "<string>",
  "callDirection": "<string>",
  "mentionedTime": "<string>",
  "summary": "<string>",
  "endedReason": "<string>"
}

Overview

The post call webhook allows you to receive real-time notifications after each call ends. This webhook sends a POST request to your specified URL containing detailed information about the completed call.

Request Format

When a call ends, our system will send a POST request to your configured URL. The request body will contain data in JSON format.

Security Considerations

To ensure the security of your webhook, we recommend: Using an HTTPS URL

Configuring the Webhook

AGENT PAGE

You can configure the post call webhook URL in the “Agent” > “Setting” > “General” > “Webhook” section of your control panel.

Response

200
application/json
Successful response
agentName
string

Name of the agent handling the call

mentionedEmail
string | null

Email address mentioned during the call

unansweredQuestions
string[]

List of questions that were not answered during the call

actionItems
string[]

List of action items identified during the call

followUpReason
string

Reason for any required follow-up

followUp
string

Indicator if follow-up is required

recordingUrl
string

URL to access the call recording

dashboardUrl
string

URL to access the call dashboard

purpose
string

Main purpose or topic of the call

sentiment
string

Overall sentiment of the call

transcriptText
string

Full text transcript of the call

transcript
object[]

Structured transcript of the call

mentionedDate
string | null

Any specific date mentioned during the call

businessPhoneNumber
string

Phone number of the agent

keyPoints
string[]

Key points or highlights from the call

topic
string

Main topic or category of the call

longSummary
string | null

Detailed summary of the call

callId
string

Unique identifier for the call

ai_success
string

Indicator of AI's success in handling the call

customerPhoneNumber
string

Phone number of the customer

callStarted
string

Date string when the call started

callEnded
string

Date string when the call ended

duration
number

Duration of the call in seconds

callerName
string

Name of the caller

callDirection
string

Direction of the call (inbound/outbound)

mentionedTime
string | null

Any specific time mentioned during the call

summary
string

Brief summary of the call

endedReason
string

Reason for the call ending