Required Data Fields for Sending/Receiving Call Data
This reference guide outlines the exact data fields used when sending contact data into SalesAi and when receiving post-call data from SalesAi. Use this guide when setting up inbound or outbound integrations between SalesAi and systems such as HubSpot, Salesforce, GoHighLevel, Google Sheets, Zapier, n8n, or another middleware platform.
This guide covers:
- Required inbound data fields
- Recommended inbound data fields
- Optional inbound data fields
- Optional location fields
- Recommended post-call fields
- Optional post-call fields
- Field naming and formatting best practices
Inbound vs. Outbound Data
SalesAi integrations commonly involve two types of data movement:
Inbound Data
Inbound data refers to information sent into SalesAi from another system.
Example:
A new lead is created in HubSpot, Salesforce, GoHighLevel, or Google Sheets. Zapier sends that lead’s information into SalesAi so the contact can be enrolled into a workflow.
Outbound / Post-Call Data
Outbound or post-call data refers to information sent from SalesAi back to another system after a call is completed.
Example:
After a SalesAi call ends, SalesAi sends the call outcome, summary, transcript, and recording URL back to a CRM, spreadsheet, or middleware workflow.
Data Sent Into SalesAiRequired Field
The only required field to pass contact data into SalesAi is:
|
Field Name |
Required? |
Description |
Example |
|
phone_number |
Yes |
The contact’s phone number used for calling |
3172223333 or +13172223333 |
Formatting Notes for phone_number
The phone number should be passed as a plain phone number value.
Examples:
3172223333
+13172223333
E.164 formatting may be required in some cases, depending on the workflow, region, or integration setup.
E.164 format includes:
- A plus sign
- Country code
- Area code
- Phone number
Example:
+13172223333
Recommended Fields
Although only phone_number is required, SalesAi recommends sending the following fields whenever possible.
|
Field Name |
Required? |
Description |
Example |
|
phone_number |
Yes |
The contact’s phone number |
3172223333 |
|
|
Recommended |
The contact’s email address |
jane.doe@example.com |
|
first_name |
Recommended |
The contact’s first name |
Jane |
|
last_name |
Recommended |
The contact’s last name |
Doe |
Sending these fields helps SalesAi create cleaner contact records, personalize conversations, and make it easier to review activity after calls.
Optional Fields
The following fields are optional but can be included when relevant to the workflow or Agent prompt.
|
Field Name |
Required? |
Description |
Example |
|
company_name |
No |
The contact’s company name |
Example Company |
|
job_title |
No |
The contact’s job title |
Operations Manager |
Optional Location Fields
For location-based use cases, the following optional fields can be passed into SalesAi.
|
Field Name |
Required? |
Description |
Example |
|
address_city |
No |
The contact’s city |
Indianapolis |
|
address_state |
No |
The contact’s state |
IN |
Use these fields when the Agent needs location context during the conversation, such as routing by territory, confirming service area, or referencing the contact’s city or state.
Example Inbound Payload
Below is an example payload that includes the required field, recommended fields, and optional fields.
{
"phone_number": "3172223333",
"email": "jane.doe@example.com",
"first_name": "Jane",
"last_name": "Doe",
"company_name": "Example Company",
"job_title": "Operations Manager",
"address_city": "Indianapolis",
"address_state": "IN"
}
Minimum Inbound Payload
At minimum, the payload must include phone_number.
{
"phone_number": "3172223333"
}
Data Sent From SalesAi After a CallRecommended Post-Call Fields
SalesAi recommends using the following fields when sending post-call data back to another system.
|
Field Name |
Required? |
Description |
|
call_outcome |
Recommended |
The result or disposition of the call |
|
call_summary |
Recommended |
A short summary of what happened during the call |
|
transcript |
Recommended |
The full call transcript |
|
recording_url |
Recommended |
A link to the call recording |
These fields are typically used to update a CRM record, create an activity log, populate a spreadsheet, or trigger additional workflow actions.
Optional Post-Call Fields
The following post-call fields are optional.
|
Field Name |
Required? |
Description |
|
call_direction |
No |
Indicates whether the call was inbound or outbound |
|
call_flow |
No |
Identifies the call flow or workflow path used |
|
call_status |
No |
Indicates the final call status |
Example Post-Call Payload
Below is an example of post-call data that may be sent from SalesAi to another system.
{
"call_outcome": "Meeting booked",
"call_summary": "The contact was interested in learning more and booked a meeting with the team.",
"transcript": "Agent: Hi Jane, this is Alex calling from Example Company...",
"recording_url": "https://example.com/recording",
"call_direction": "outbound",
"call_flow": "prompt",
"call_status": "success"
}
Field Reference SummaryFields Sent Into SalesAi
|
Category |
Field Name |
|
Required |
phone_number |
|
Recommended |
phone_number |
|
Recommended |
|
|
Recommended |
first_name |
|
Recommended |
last_name |
|
Optional |
company_name |
|
Optional |
job_title |
|
Optional Location |
address_city |
|
Optional Location |
address_state |
Fields Sent From SalesAi
|
Category |
Field Name |
|
Recommended Post-Call |
call_outcome |
|
Recommended Post-Call |
call_summary |
|
Recommended Post-Call |
transcript |
|
Recommended Post-Call |
recording_url |
|
Optional Post-Call |
call_direction |
|
Optional Post-Call |
call_flow |
|
Optional Post-Call |
call_status |
Field Naming Best Practices
When mapping fields in Zapier, n8n, or another middleware platform, use the exact SalesAi field names.
Field names should be:
- Lowercase
- Written exactly as shown
- Formatted with underscores where applicable
- Free of extra spaces before or after the field name
Correct examples:
phone_number
first_name
address_city
Incorrect examples:
phone number
Phone_Number
firstName
city
Integration Setup Notes
When setting up an integration, make sure:
- The SalesAi workflow is active.
- The contact has a valid phone_number.
- The webhook URL is copied exactly from SalesAi.
- The required webhook header is included, if required.
- The payload type is set to JSON when using Zapier Webhooks.
- Field names match the SalesAi field names exactly.
- Test data includes a real phone number that can receive a test call.
SalesAi Webhook Header
For webhook-based integrations, SalesAi may require a shared secret header.
Use the following header:
|
Header Key |
Header Value |
|
X-SalesAi-Webhook-Shared-Secret |
The SalesAi webhook secret key |
The header key must be entered exactly as shown.
X-SalesAi-Webhook-Shared-Secret
Still Need Help?
If the integration is not working as expected, email support@salesai.com and include the following information:
- The integration or Zap name
- The SalesAi workflow name
- The source system, such as HubSpot, Salesforce, GoHighLevel, or Google Sheets
- A screenshot of the field mapping
- A screenshot of the webhook POST step
- A screenshot of the webhook headers section
- A sample payload
- Any error message shown in the middleware platform
- The test contact name and phone number
This information helps Support identify whether the issue is related to field mapping, phone number formatting, webhook authentication, workflow status, or post-call data handling.