Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

KUFU Webhook API

Webhook を操作します

KUFU Webhook API is one of 2 APIs that KUFU publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, API documentation, an API reference, a getting-started guide, and a changelog.

This API exposes 6 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 2.0, at version 0.0.1.

Requests are made against the base URL https://app.smarthr.jp/api/v1.

6 operations 2 paths 4 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
0.0.1
Base URL
https://app.smarthr.jp/api/v1
License
SmartHR, Inc
Resource Areas
1

Paths & Operations 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhook 6

Webhook を操作します

GET
/v1/webhooks/{id}
取得
getV1WebhooksId 1 param → 200
PUT
/v1/webhooks/{id}
更新
putV1WebhooksId 2 params → 200
PATCH
/v1/webhooks/{id}
部分更新
patchV1WebhooksId 2 params → 200
DELETE
/v1/webhooks/{id}
削除
deleteV1WebhooksId 1 param → 204
GET
/v1/webhooks
リストの取得
getV1Webhooks 2 params → 200
POST
/v1/webhooks
登録
postV1Webhooks 1 param → 201

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Webhook (16 properties), putV1WebhooksId (14 properties), postV1Webhooks (14 properties), patchV1WebhooksId (14 properties). Each schema is shown below with its type and property counts.

patchV1WebhooksId
object
部分更新
14 properties 8 required
postV1Webhooks
object
登録
14 properties 8 required
putV1WebhooksId
object
更新
14 properties 8 required
Webhook
object
Webhook model
16 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kufu-webhook-api-openapi.yml Raw ↑

Other APIs KUFU publishes across the network.

KUFU カスタム家族項目テンプレート API