Open documentation ↗Overview
Provides a way for apps to subscribe to certain change events in HubSpot. Once configured, apps will receive event payloads containing details about the changes at a specified target URL. There can only be one target URL for receiving event notifications per app.
Webhooks API is a business API from hubapi.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 9 endpoints.
At a glance
- Authentication
- API key
- HTTPS
- Yes
- CORS
- Unknown
- Category
- Business
- Base URL
https://api.hubapi.com/- Version
- v3
- Endpoints
- 9
- OpenAPI
- Specification ↗
- Spec updated
- 2022-03-25
Make a first request
Replace the placeholders; the documentation says exactly where credentials go.
curl -X GET "https://api.hubapi.com/webhooks/v3/APPID/settings" \
-H "Accept: application/json" \
-H "X-API-Key: YOUR_API_KEY"const response = await fetch("https://api.hubapi.com/webhooks/v3/APPID/settings", {
method: "GET",
headers: {
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
});
const data = await response.json();
console.log(data);import requests
response = requests.request(
"GET",
"https://api.hubapi.com/webhooks/v3/APPID/settings",
headers={
"Accept": "application/json",
"X-API-Key": "YOUR_API_KEY",
},
timeout=30,
)
print(response.json())Endpoints
| Method | Path | What it does |
|---|---|---|
| GET | /webhooks/v3/{appId}/settings | get-/webhooks/v3/{appId}/settings_getAll |
| PUT | /webhooks/v3/{appId}/settings | put-/webhooks/v3/{appId}/settings_configure |
| DELETE | /webhooks/v3/{appId}/settings | delete-/webhooks/v3/{appId}/settings_clear |
| GET | /webhooks/v3/{appId}/subscriptions | get-/webhooks/v3/{appId}/subscriptions_getAll |
| POST | /webhooks/v3/{appId}/subscriptions | post-/webhooks/v3/{appId}/subscriptions_create |
| POST | /webhooks/v3/{appId}/subscriptions/batch/update | post-/webhooks/v3/{appId}/subscriptions/batch/update_updateBatch |
| GET | /webhooks/v3/{appId}/subscriptions/{subscriptionId} | get-/webhooks/v3/{appId}/subscriptions/{subscriptionId}_getById |
| PATCH | /webhooks/v3/{appId}/subscriptions/{subscriptionId} | patch-/webhooks/v3/{appId}/subscriptions/{subscriptionId}_update |
| DELETE | /webhooks/v3/{appId}/subscriptions/{subscriptionId} | delete-/webhooks/v3/{appId}/subscriptions/{subscriptionId}_archive |
Questions
Does the Webhooks API API need an API key?
Yes. The Webhooks API API uses API key authentication; the documentation explains how to get credentials.
Does the Webhooks API API support HTTPS?
Yes, the Webhooks API API is served over HTTPS.
How many endpoints does the Webhooks API API have?
Its OpenAPI description lists 9 endpoints in version v3. All of them are shown on this page.
What are alternatives to the Webhooks API API?
Other Business APIs include Gmail, Google Analytics, Apache Superset, Trello, Square.
Similar business APIs
Compare alternatives →Gmail
BusinessFlexible, RESTful access to the user's inbox
Google Analytics
BusinessCollect, configure and analyze your data to reach the right audience
Apache Superset
BusinessAPI to manage your BI dashboards and data sources on Superset
Trello
BusinessBoards, lists and cards to help you organize and prioritize your projects
Square
BusinessEasy way to take payments, manage refunds, and help customers checkout online
Mailchimp
BusinessSend marketing campaigns and transactional mails
Listed from APIs.guru (CC0).