# Overview of API Integrations #### With Get The Referrals API Integrations, you can: - Push leads from the Get The Referral (GTR) app, into your CRM - Synchronize lead status from your CRM, into GTR - Synchronize project stages from your CRM, into GTR - Push documents to all advocates or specific advocates - Manage advocates - Manage leads - Manage sales reps - Manage payments ![Integrations Diagram](https://advocator.getthereferral.com/advocator/public/upload/LeadPushGraphic.png) --- ## Lead Push (from GTR to your CRM) When an advocate makes a referral through the application, the referrals contact information is stored in the GTR database as a “lead”. You can then push that lead to your CRM or other external service using [Zapier](docs/gtr/ZG9jOjI4MDA5OTMw-push-leads-to-your-crm-with-zapier) or directly with a webhook. The Lead Push integration is considered real-time; when a referral is submitted by an advocate, it is pushed to your CRM in minutes, if not seconds. ### Zapier Zapier is the preferred method for Lead Push integration. Lead push via Zapier works with just about any CRM or external service, most even have their own first party Zappier App to facilitate the integration. > You will need a paid Zapier account for this integration if you plan to sync the lead status from your CRM to Get The Referral. [Learn more about using Zapier to sync your leads](docs/zapier/by7cc1r91p178-new-lead-trigger) ### Webhook A webhook is recommended if your integration requirements are more complex or would rather not use Zapier for any reason. This method must be configured by a Get The Referral Integration Engineer. To get started, contact your GTR account manager with the following details: - Name of the crm - Authentication details - Field mappings - Endpoint to push to and HTTP method to use (if applicable) > Additional integration fees may apply. --- ## Lead Status Update (from your CRM to GTR) When the status of a lead changes in your CRM, the Lead Status Change integration can make sure that same change is also made in Get The Referral. This is necessary for the advocate to track the change in their app and to facilitate referral rewards. ### Zapier Zapier is the preferred method for Lead Status Update integration. Many CRM's and external services have their own Zappier triggers that you can tap into for this purpose. This method is considered real-time; when a change is made in your CRM, it will be reflected in GTR in minutes, if not seconds. [Learn more about using Zapier to keep your lead statuses in sync](docs/zapier/pvmh9fowz0lth-lead-status-update-action) ### Webhook If your CRM supports webhooks, you may be able to use them to push lead status updates directly to GTR. The endpoint to use, parameters, and authentication details can be found in our [API documentation](docs/gtr/hcxqj8uakubbt-update-lead-status). This method is considered real-time; when a change is made in your CRM, it will be reflected in GTR in minutes, if not seconds. > If your CRM does not support sending custom values for the status field, you will need to provide your account manager with your desired status mappings. ### API Polling If your CRM does not have a compatible Zapier app or webhook functionality, but does have an API, we may be able to configure an integration that polls your via an HTTP request occasionally. The CRM returns the necessary lead data for GTR to properly sync the lead statuses. Polling occurs every 60 minutes; status changes in your CRM can take up to 60 minutes to reflect in GTR. This method must be configured by a Get The Referral Integration Engineer. Contact your GTR account manager to get started. > Additional integration fees may apply. --- ## Project Stage Update (from your CRM to GTR) Your advocates can keep track of their project statuses in the app. When the status of a project changes in your CRM, status in the app can be synced to that change with a Project Stage Update integration. ### Zapier Zapier is the preferred method for Project Stage Update integration. Project Stage Updates via Zapier works with any CRM or external service that provides Zappier triggers for changes to the objects that your CRM's project stage fields are on. And, although it may require more technical expertise to get set up, it will also work with CRM's that provide access to custom webhook on those same objects. This method is considered real-time; when a change is made in your CRM, it will be reflected in GTR in minutes, if not seconds. [Learn more about using Zapier to keep your advocates project stages up to date](docs/zapier/wd16478gn4sd5-project-stage-update-action) ### Webhook If your CRM has webhook support, you may be able to use that to push project stage updates directly to GTR. The endpoint to use, parameters, and authentication details can be found in our [API documentation](docs/gtr/uk9ph7pfc1htb-update-project-stage-by-email-address). This method is considered real-time; when a change is made in your CRM, it will be reflected in GTR in minutes, if not seconds. > If your CRM does not support sending custom values for the stage field, you will need to provide your account manager with your desired mappings for the stages. ### API Polling If your CRM does not have a compatible Zapier app or webhook functionality, but does have an API, we may be able to configure an integration that polls your via an HTTP request occasionally. The CRM returns the necessary project data for GTR to properly sync the advocates project stages. Polling occurs every 60 minutes; stage changes in your CRM can take up to 60 minutes to reflect in GTR. This method must be configured by a Get The Referral Integration Engineer. Contact your GTR account manager to get started. > Additional integration fees may apply.