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 Salesforce Integration API

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

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

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

25 operations 18 paths 22 schemas 3 DELETE12 GET2 PATCH4 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Magic Moment Playbook Salesforce 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 25

Across 18 paths, the API surfaces 25 operations — 3 DELETE, 12 GET, 2 PATCH, 4 POST, 4 PUT. They span 7 resource areas: fetch_sfdc, engagement_sync_settings, utils, mappings, oauth2, settings, sync_sfdc. Each is listed below with its method, path, parameters, and response codes.

fetch_sfdc 3
GET
/crm/lead_statuses
Get value from Salesforce LeadStatus Object
getLeadStatusOfSfdc → 200
GET
/crm/opportunity_stages
Get value from Salesforce OpportunityStage Object
getOpportunityStageOfSfdc → 200
GET
/crm/users
Show list salesforce users API
getSalesforceUsers 2 params → 200
engagement_sync_settings 3
GET
/engagement_sync_settings
Get EngagementSyncSetting data beetwen Playbook Salesforce
getEngagementSyncSettingOfSfdc → 200
PUT
/engagement_sync_settings
Create/update EngagementSyncSetting data beetwen Playbook Salesforce
saveEngagementSyncSettingOfSfdc 1 param → 200
DELETE
/engagement_sync_settings/{engagement_sync_setting_id}/
Delete Engagement sync setting
deleteEngagementSyncSettingOfSfdc 1 param → 200
utils 1
GET
/healthcheck
ヘルスチェック
healthCheck → 200
mappings 3
GET
/mappings
Playbook Salesforce の ID の対応関係を取得する
getSyncIDMapOfSfdc 2 params → 200
PUT
/mappings
Playbook Salesforce の ID の対応関係を設定する
saveSyncIDMapOfSfdc 1 param → 201
DELETE
/mappings/{mapping_id}/
Delete mapping
deleteSyncIDMapOfSfdc 1 param → 200
oauth2 5
PUT
/oauth2/access-tokens
Update access tokens for all tenants
updateAccessTokens → 204
GET
/oauth2/authorize/
Salesforce認証・認可
startSfdcAuth 2 params → 200302
DELETE
/oauth2/authorize/
Unlink service
deleteSfdcAuth → 200
GET
/oauth2/callback/
Salesforce認可コールバック
callbackSfdcAuth 2 params → 201302
GET
/oauth2/results
認証結果一覧
listOauthResults → 200
settings 7
GET
/settings
Salesforce読み込み設定の取得
getSyncSettingOfSfdc 1 param → 200
POST
/settings
Playbook Salesforce の対応関係設定追加
createSyncSettingOfSfdc 1 param → 201
GET
/settings/marketo
Marketo認証設定の取得
getCredentialSettingOfMarketo → 200
POST
/settings/marketo
Marketo認証設定の登録
createCredentialSettingsOfMarketo 1 param → 201
PATCH
/settings/marketo
Marketo認証設定の更新
updateCredentialSettingsOfMarketo 1 param → 200
PATCH
/settings/{sync_setting_id}
Playbook Salesforce の対応関係設定更新
updateSyncFieldMapOfSfdc 2 params → 201
POST
/settings/{sync_setting_id}/engagement
Engagement の対応関係設定追加
createEngagementSyncSettingOfSfdc 2 params → 201
sync_sfdc 3
POST
/sync/read
Salesforce からデータを読み込み Playbook にデータを反映する
readSyncWithSfdc 1 param → 201
GET
/sync/syncable
同期状態
getSyncable 1 param → 200
PUT
/sync/syncable
同期開始・ストップ
toggleSyncable 1 param → 200

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are sync_setting (8 properties), salesforceUser (7 properties), marketo_credential_setting (5 properties), principal (4 properties). Each schema is shown below with its type and property counts.

createdAt
string
作成日
engagement_sync_setting
object
4 properties
error
object
2 properties 1 required
marketo_credential_setting
object
5 properties 5 required
mmp_id
string
mmp_table_name
string
oauthResult
object
3 properties
principal
object
4 properties
redirect_url
string
salesforceUser
object
7 properties
services
string
sfdc_api_name
object
2 properties
sfdc_id
string
sfdc_object_name
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-salesforce-integration-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of Magic Moment Playbook Salesforce 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.