How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Magic Moment Playbook HubSpot Integration API

Swagger 2.0 contract for the Playbook HubSpot integration service: OAuth 2.0 connection to HubSpot, sync settings and field mappings, Playbook HubSpot ID mappings, engagement sync settings, HubSpot deal stages / lead statuses / users lookups, and read-sync triggering. Authenticated with an x-access-token or x-api-key header.

This API exposes 20 operations across 15 paths, organized into 7 resource areas, and defines 19 schemas. It is described by OpenAPI 2.0, at version 1.0.0.

Requests are made against the base URL https://hubspot.magicmoment.co.jp/.

20 operations 15 paths 19 schemas 3 DELETE11 GET1 PATCH2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0.0
Base URL
https://hubspot.magicmoment.co.jp/
Authentication
API Key, API Key
Resource Areas
7

Authentication & Security 2

Magic Moment Playbook HubSpot Integration API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-access-token (accessToken). An API key is passed in the header as x-api-key (apiKey).

Paths & Operations 20

Across 15 paths, the API surfaces 20 operations — 3 DELETE, 11 GET, 1 PATCH, 2 POST, 3 PUT. They span 7 resource areas: fetch_hubspot, engagement_sync_settings, utils, mappings, oauth2, settings, sync_hubspot. Each is listed below with its method, path, parameters, and response codes.

fetch_hubspot 3
GET
/crm/deal_stages
Get value from Hubspot dealstages Object
getDealStagesOfHubspot → 200
GET
/crm/hs_lead_statuses
Get value from Hubspot hsleadstatus Object
getHsLeadStatusOfHubspot → 200
GET
/crm/users
Show list hubspot users API
getHubspotUsers 2 params → 200
engagement_sync_settings 3
GET
/engagement_sync_settings
Get EngagementSyncSetting data beetwen Playbook Hubspot
getEngagementSyncSettingOfHubspot → 200
PUT
/engagement_sync_settings
Create/update EngagementSyncSetting data beetwen Playbook Hubspot
saveEngagementSyncSettingOfHubspot 1 param → 200
DELETE
/engagement_sync_settings/{engagement_sync_setting_id}/
Delete Engagement sync setting
deleteEngagementSyncSettingOfHubspot 1 param → 200
utils 1
GET
/healthcheck
ヘルスチェック
healthCheck → 200
mappings 3
GET
/mappings
Playbook Hubspot の ID の対応関係を取得する
getSyncIDMapOfHubspot 2 params → 200
PUT
/mappings
Playbook Hubspot の ID の対応関係を作成・更新する
saveSyncIDMapOfHubspot 1 param → 201
DELETE
/mappings/{mapping_id}/
Delete mapping
deleteSyncIDMapOfHubspot 1 param → 200
oauth2 4
GET
/oauth2/authorize/
Hubspot認証・認可
startHubspotAuth 1 param → 200302
DELETE
/oauth2/authorize/
Unlink service
deleteHubspotAuth → 200
GET
/oauth2/callback/
Hubspot認可コールバック
callbackHubspotAuth 2 params → 201302
GET
/oauth2/results
認証結果一覧
listOauthResults → 200
settings 3
GET
/settings
Hubspot読み込み設定の取得
getSyncSettingOfHubspot 1 param → 200
POST
/settings
Playbook Hubspot の対応関係設定追加
createSyncSettingOfHubspot 1 param → 201
PATCH
/settings/{sync_setting_id}
Playbook HubSpot の対応関係設定更新
updateSyncFieldMapOfHubspot 2 params → 201
sync_hubspot 3
POST
/sync/read
Hubspotからデータを読み込み Playbook にデータを反映する
readSyncWithHubspot 1 param → 201
GET
/sync/syncable
同期状態
getSyncable 1 param → 200
PUT
/sync/syncable
同期開始・ストップ
toggleSyncable 1 param → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are sync_setting (8 properties), hubspotUser (7 properties), sync_id_map (4 properties), engagement_sync_setting (4 properties). Each schema is shown below with its type and property counts.

createdAt
string
作成日
engagement_sync_setting
object
4 properties
hubspotUser
object
7 properties
hubspot_api_name
object
2 properties
hubspot_id
string
hubspot_object_name
string
mmp_id
string
mmp_table_name
string
oauthResult
object
2 properties
redirect_url
string
services
string
sync_field_map
string
sync_id_map
object
4 properties
sync_id_maps
array
sync_setting
object
8 properties
sync_setting_id
string
sync_settings
array
syncable
object
2 properties
write_sync_pattern
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

magic-moment-hubspot-integration-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Magic Moment Playbook HubSpot Integration API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.