Return a list of existing webhook endpoints. Webhooks are a way to register an endpoint on your server with HubSpot and be notified when a new lead has been created. Leads will be "pushed" to you in this model. Webhooks provide a near-real-time way to keep your system notified of events in HubSpot. It's an efficient, scalable architecture, and often a neat way to replace "polling" for leads and scheduled jobs to check if new leads have converted in HubSpot. Webhooks are limited to HubSpot Professional and Enterprise customers only.
If our webhook call fails (fails to open a connection to the URL registered), we will re-try the call at the following times: After the first failure, we'll wait 5 seconds, then 30 seconds, then 1 minute, then 5 minute, then 30 minutes, then once an hour for 24 hours, then once every 3 hours for a week, then once a day for 3 weeks.
For a general background on Webhooks and why they're useful, read this ProgrammableWeb article.
| Required Parameters | How to use | Description |
|---|---|---|
| HubSpot API Key | hapikey=X - Used in the request URL | The HubSpot API key for the portal that you're making the call for. You can generate a HubSpot API key here. |
| Optional Parameters | How to use | Description |
|---|---|---|
| None | None | No optional parameters for this method. |
Example URL: https://api.hubapi.com/leads/v1/callback-url/?hapikey=demo
Please Note Unlike other API endpoints, the webhooks methods require you to use HubSpot API Keys (hapikey) instead of OAuth access tokens. You can generate a HubSpot API key here.
The response from this API call are JSON objects representing the endpoints in the response body. These JSON objects include the endpoint GUID and URL that HubSpot will be POSTing leads to. Here's an example of the request
{
"guid": "8a40135230f21bdb0130f21c255c2345",
"url": "https://yourdomain.com/endpoint_url"
}
{"1": {
"guid": "8a40135230f21bdb0130f21c255c0007",
"portalId": ,
"publicLeadLink": "https://app.hubspot.com/leads/public/leadDetails?portalId=53&leadToken=",
"ipAddress": "0.0.0.0",
"userToken": "7ce9935bebcc4c68932cc6",
"salutation": "",
"firstName": "John",
"lastName": "Doe",
"jobTitle": "CEO",
"company": "HubSpot",
"address": "25 First Street",
"city": "Cambridge",
"state": "MA",
"zip": "02139",
"country": "USA",
"email": "johndoe@hubspot.com",
"fax": "555-123-1231",
"phone": "555-123-1230",
"twitterHandle": "@hubspot",
"website": "www.hubspot.com",
"industry": "Software",
"numConversionEvents": 2,
"firstConversionEvent": {
"formGuid": "318ccf3233224a629f23",
"formName": "Free eBook",
"convertDate": 1309731973000,
"guid": "c9c676e62b3d482b845",
"formNote": null,
"url": "http://www.hubspot.com/",
"pageName": "Free eBook"
},
"lastConversionEvent": {
"formGuid": "edeb95dd89904b56a2bc20ecc",
"formName": "How to Use Facebook for Business 2011 - Ebook",
"convertDate": 1312247994000,
"guid": "87da3c33c21447caae587",
"formNote": null,
"url": "http://www.hubspot.com/",
"pageName": "How to Use Facebook for Business - Free HubSpot eBook"
},
"recentConversionEvents": [{
"formGuid": "318ccf3233224a629f23a0",
"formName": "Free eBook",
"convertDate": 1309731973000,
"guid": "c9c676e62b3d482b845",
"formNote": null,
"url": "http://www.hubspot.com/",
"pageName": "Free eBook"
},
{
"formGuid": "edeb95dd89904b56a2bc20e",
"formName": "How to Use Facebook for Business 2011 - Ebook",
"convertDate": 1312247994000,
"guid": "87da3c33c21447caae5873",
"formNote": null,
"url": "http://www.hubspot.com/",
"pageName": "How to Use Facebook for Business - Free HubSpot eBook"
}],
"message": ""
}}
HTTP Methods:
GET
Response Format:
JSON
Requires Authentication?
Yes
Rate Limited?
Headers
None Yet