Skip to main content
WEBHOOK
post-call
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "direction": "INBOUND",
  "status": "COMPLETED",
  "fromNumber": "<string>",
  "toNumber": "<string>",
  "organizationId": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recordingUrl": "<string>",
  "hangupCause": "<string>",
  "errorMessage": "<string>",
  "transcript": [
    {}
  ],
  "summary": "<string>",
  "metrics": {},
  "initiatedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "endedAt": "2023-11-07T05:31:56Z",
  "durationSeconds": 123,
  "agentName": "<string>",
  "sipTrunkId": "<string>",
  "agentCallerIdName": "<string>",
  "variables": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.revring.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Body

application/json
​
id
string<uuid>
required

Call ID

​
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND
​
status
enum<string>
required
Available options:
COMPLETED,
TRANSFERRED,
FAILED,
CANCELED
​
fromNumber
string
required

Caller's number (E.164)

​
toNumber
string
required

Called number (E.164)

​
organizationId
string
required

Organization ID

​
agentId
string<uuid>
required

Agent ID that handled the call

​
recordingUrl
string | null

URL to call recording

​
hangupCause
string | null

Reason call ended. Common values: USER_ENDED, END_CALL_TOOL, SILENCE_TIMEOUT, MAX_DURATION, VOICEMAIL_DETECTED

​
errorMessage
string | null

Error message if call failed

​
transcript
object[] | null

Conversation transcript

​
summary
string | null

AI-generated call summary

​
metrics
object

Call quality metrics

​
initiatedAt
string<date-time>
​
startedAt
string<date-time> | null
​
endedAt
string<date-time> | null
​
durationSeconds
integer | null

Call duration in seconds

​
agentName
string | null

Agent name

​
sipTrunkId
string | null

SIP trunk ID used for the call

​
agentCallerIdName
string | null

Caller ID name configured on the agent

​
variables
object

Merged template variables used during the call (includes pre-call webhook variables, API variables, and system variables)

​
createdAt
string<date-time>

When the call record was created

​
updatedAt
string<date-time>

When the call record was last updated

Response

200

Webhook received successfully