User Tools

Site Tools


outgoing_leads_api

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
outgoing_leads_api [2015/10/05 21:22]
igor [Outgoing Leads API]
outgoing_leads_api [2020/05/28 21:06] (current)
michaels
Line 1: Line 1:
 +#redirect https://​support.realgeeks.com/​hc/​en-us/​articles/​360043209594
 ====== Outgoing Leads API ====== ====== Outgoing Leads API ======
  
-**This document is directed to Real Geeks clients interested in sending their Leads to other destination(s) besides the Lead Manager. ​ If you're developer creating an API to receive Leads visit [[outgoing_leads_api_developers|this page]] +**This document is directed to Real Geeks clients interested in sending their Leads to other destination(s) besides the Lead Manager.** 
-**+ 
 +**If you're developer creating an API to receive Leads visit https://​developers.realgeeks.com/​outgoing-leads-api/​**
  
 Real Geeks allow leads to be published to external systems as they come in from our clients websites. Real Geeks allow leads to be published to external systems as they come in from our clients websites.
Line 30: Line 32:
 If you want to build your own API to receive Real Geeks Leads and Activities choose the Custom API option. The following information is required: If you want to build your own API to receive Real Geeks Leads and Activities choose the Custom API option. The following information is required:
  
-  * **Name**: this is just a descriptive name to identify this destination.  It won't be available to anywhere else, only this your account and for this site. +  * **Name**: this is just a descriptive name to help you identify this destination ​later 
-  * **URL**: the API url to receive all requests. +  * **URL**: the API url to receive all requests, all HTTP requests will be sent to this url. 
-  * **Partner ID**: this is an identification of your Real Geeks account that will be sent over on every request as "​partner_id"​ field.  ​+  * **Secret**: this is a secret key used to sign all HTTP requests, learn more in our [[outgoing_leads_api_developers#​security|security docs]] 
 +  * **Partner ID**: this is an identification of your Real Geeks account that will be sent over on every request as "​partner_id"​ field
   * Make sure “Active” is checked   * Make sure “Active” is checked
   * Click save   * Click save
  
-In order to implement a custom API url you'll need to understand lead formatsee our Outgoing API Request Format page for details. +In order to implement a custom API url you'll need to understand ​the lead format.  For details ​see our [[outgoing_leads_api_developers|developer docs]].
 ==== Active ==== ==== Active ====
  
-Be it a registered or custom ​destination, the connection ​has to be **Active** for leads to be sent over.  If you want to stop receiving ​Leads just deactivate. ​ Or if you know this connection won't be used anymore in the future, delete.+destination has to be **Active** for leads to be sent over.  If you want to stop sending ​Leads to that destination ​just deactivate ​it.  Or if you know this connection won't be used anymore in the future, delete
 + 
 +Lead Manager is the only destination that can't be disabled nor deleted.
outgoing_leads_api.1444080145.txt.gz · Last modified: 2015/10/05 21:22 by igor