HubSpot

Webhooks API

Provides a way for apps to subscribe to certain change events in HubSpot. Once configured, apps will receive event payloads containing details about the…

Other#openapi#customer-relation

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

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.

Endpoints 9

Settings

  • GETget-/webhooks/v3/{appId}/settings_getAll/webhooks/v3/:appId/settings
  • PUTput-/webhooks/v3/{appId}/settings_configure/webhooks/v3/:appId/settings
  • DELETEdelete-/webhooks/v3/{appId}/settings_clear/webhooks/v3/:appId/settings

Subscriptions

  • GETget-/webhooks/v3/{appId}/subscriptions_getAll/webhooks/v3/:appId/subscriptions
  • POSTpost-/webhooks/v3/{appId}/subscriptions_create/webhooks/v3/:appId/subscriptions
  • POSTpost-/webhooks/v3/{appId}/subscriptions/batch/update_updateBatch/webhooks/v3/:appId/subscriptions/batch/update
  • GETget-/webhooks/v3/{appId}/subscriptions/{subscriptionId}_getById/webhooks/v3/:appId/subscriptions/:subscriptionId
  • DELETEdelete-/webhooks/v3/{appId}/subscriptions/{subscriptionId}_archive/webhooks/v3/:appId/subscriptions/:subscriptionId
  • PATCHpatch-/webhooks/v3/{appId}/subscriptions/{subscriptionId}_update/webhooks/v3/:appId/subscriptions/:subscriptionId

API details

Base URL
https://api.hubapi.com
Authentication
An API key in the hapikey query parameter
Operations
9 operations on 4 pathsGET 3POST 2DELETE 2PUT 1PATCH 1
Main resources
Subscriptions 6Settings 3
Response formats
application/json
Description format
OpenAPI 3.0.1, API version v3
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Webhooks API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Webhooks API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the hapikey query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “get-/webhooks/v3/{appId}/settings_getAll” (GET /webhooks/v3/:appId/settings), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Webhooks API?

Provides a way for apps to subscribe to certain change events in HubSpot. Once configured, apps will receive event payloads containing details about the… It is listed under Other and has 9 endpoints.

Who publishes the Webhooks API?

It is listed from HubSpot's public API description (an OpenAPI document), not published by HubSpot on Swastik Codes. Anyone who controls hubapi.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Webhooks API?

Requests go to https://api.hubapi.com. Endpoint paths are added to this base URL.

How do I authenticate with the Webhooks API?

With an API key in the hapikey query parameter.

How many endpoints does the Webhooks API have?

9 operations on 4 paths (3 GET, 2 POST, 2 DELETE, 1 PUT, 1 PATCH). The largest groups are Subscriptions, Settings.

Is forking the Webhooks API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.