For a full overview of the webhooks offered, read our Developer Documentation.
Security keys for Webhooks
CallRail generates a secret, random token for every company. You can view these on the webhooks configuration page as outlined in the next section. The token is used with the request payload to generate a hash signature that is passed as a request header in the webhook request. You can use the secret token on your server to recompute the same hash based on the request payload. The request is valid if your computed signature matches the header that CallRail sends.
How to Use Advanced Security Settings.
Adding a Webhook to CallRail
- Select the Integrations icon on the left navigation bar.
- Choose Webhooks from the list of integrations.
- Choose the company where you’d like to use webhooks.
- Find the webhook you'd like to use, and enter your endpoint.
- Select Activate when finished.
Information sent with webhooks
Pre-call
- answered=false
- call_type=missed (and formatted_call_type)
- Customer_city
- Customer_country
- Customer_name
- Customer_number
- customer_state
- Company_id
- company_name
- Company_resource_id
- Company_time_zone
- Created_at
- direction
- duration=0 (and formatted_duration)
- first_call
- Formatted_tracking_phone_number
- Person_resource_id
- Prior_calls
- Resource_id
- Source_name
- Start_time
- Total_calls
- Tracker_resource_id
- Tracking_phone_number
- voicemail=false
Call routing complete
- Business_phone_number (and formatted_business_phone_number)
- may see tags if applied through a call flow
- may see some attribution data if applied through a call flow
Post-call (including outbound)
- Everything else
- < 1% of calls will still be missing recording and/or transcription
- We have a max timeout of 20 minutes, if still not attached we fire the event anyway
- This is why call modified webhook exists and we encourage customers that are recording OR manually adding notes/tags/values/scores to calls to subscribe to it
Call modified
- Changes: An array of the changes to the call that triggered the call modified webhook appended to the end of the normal response fields. These fields include tags, note, value, transcription_text, recording_duration, auto_score, and manual_score.
Text message sent
- id
- resource_id
- source_number
- destination_number
- content
- timestamp
- lead_status
- conversation_id
- company_resource_id
- person_resource_id
Text message received
- id
- resource_id
- agent
- source_number
- destination_number
- content
- timestamp
- lead_status
- conversation_id
- company_resource_id
- person_resource_id
Form submission
- Id
- Company_id
- Form_data
- form_url
- landing_page_url
- referrer
- submitted_at
- referring_url
- first_form
- source
- keywords
- campaign
- medium
- utm_source
- utm_medium
- utm_campaign
Convert assist
- person_resource_id
- last_interaction_resource_id
- last_interaction_type
- answers
- interaction_count
- timestamp
Deactivating Webhooks
Deactivating a company's webhooks will prevent CallRail from sending your data to your third-party integrations. We'll keep your webhooks saved in case you'd like to reactivate your integration in the future.
- Select the Settings icon on the left navigation bar on the left.
- Choose the company where you'd like to deactivate webhooks.
- Select Integrations at the top of the page.
- Choose Webhooks from the list of integrations.
- Select Deactivate Integration on the right side of the page.
FAQs
What if I'm already using cookies to get data on my site visitors?
If you're using a third-party tool to track visitors via cookies, you can use webhooks to associate visitor data with phone calls to your CallRail numbers through our Custom Cookie Capture integration. Use this article to learn more about setup and usage of this feature.