Resources

Guides and reference material.

Webhook ingestion

Send call event data from your routing or tracking platform into Aria via HTTP webhooks.

Overview

Configure your platform to POST call completion and disposition events to Aria. Aria ingests each payload for transcription, scoring, and outcome reporting alongside your existing call stack.

Endpoint & authentication

Your Aria representative provides the ingestion URL, api_key, and connection_id for your integration. Include those values with each webhook request as configured during onboarding.

Payload format

Webhook bodies include the following fields. Types reflect how values are represented in the payload; string-encoded booleans and numbers may be normalized by your integration.

Field	Type	Description
api_key	string	API key used to authenticate the webhook request (provided by rep).
connection_id	string	Unique ID for the integration/connection (provided by rep).
call_instance_id	string	Unique identifier for the specific call.
buyer_name	string	Name of the buyer receiving the call.
client_id	integer	Internal client identifier.
call_date	string	Timestamp of the call (MM/DD/YYYY HH:MM:SS AM/PM).
caller_id	string	Caller's phone number.
campaign_id	string	Unique campaign identifier.
campaign_name	string	Human-readable campaign name.
campaign_tracking_id	string	Tracking ID for campaign.
connected_call_length	string	Connected call duration (seconds).
converted	string ("True" / "False")	Indicates if the call converted.
duration	string	Total call duration (seconds).
end_call_source	string	Who ended the call (Caller, Callee, System).
inbound_number_state	string	State of inbound number.
is_duplicate	string ("true" / "false")	Whether the call is a duplicate.
cost	string	Cost of the call.
publisher_sub_id	string	Publisher sub ID.
publisher_name	string	Publisher name.
recording	string (URL)	Link to call recording.
referrer_url	string	Referring URL.
revenue	string	Revenue generated.
subsource	string	Subsource tracking value.
target_did	string	Dialed number.
target_name	string	Target/buyer endpoint name.
target_sub_id	string	Target sub ID.
time_to_call	string	Time before call initiated (seconds).
time_to_connect	string	Time to connect (seconds).
zip_code	string	Caller ZIP/postal code.
data_source	string	Source of the data.
vertical	string	Industry vertical.
sale_amount	number \| null	Sale amount if applicable.
sale_count	number \| null	Number of sales.
client_lead_id	string \| null	Client lead identifier.
branch_name	string	Branch/location name.
affiliate_payout	string	Affiliate payout amount.