Nitte 人材紹介 API
  1. Webhook
Nitte 人材紹介 API
  • API
    • 認証
    • エラー
    • 企業担当者
      • 作成
      • 取得
      • 一覧
      • 更新
      • 削除
    • 求職者
      • 作成
      • 取得
      • 一覧
      • 更新
      • 削除
    • 日程調整
      • 作成
      • 取得
      • 一覧
      • 更新
      • 削除
  • Webhook
    • Webhook
  1. Webhook

Webhook

日程調整に更新があった際に、Webhookを受信できます。
このWebhookを用いて、御社システムの日程調整のステータスとNitteのステータスをリアルタイムに同期できます。
image.png

設定方法#

設定 > 開発者設定より、URL及びセキュリティトークンを設定します。
テスト送信から、テストデータでのWebhookの受信も行えます。
CleanShot 2024-04-11 at 17.54.42.png

リクエスト#

Webhookは以下の形式でリクエストされます。

メソッド#

POST

ヘッダー#

X-Nitte-Tokenには設定した、セキュリティトークンが入ります。
Nitteからのリクエストであるかを検証するのにお使いください。
headers: {
    'Content-Type': 'application/json',
    'X-Nitte-Token': {securityToken},
    'User-Agent': 'Nitte Webhook'
}

ボディ#

WebhookBody
type
enum<string> 
必須
Webhookの種別です。
列挙型:
bookingAction
actionType
enum<string> 
必須
実行されたアクションの種類です。
列挙型:
startproposeselectapprovecancel
booking
object (日程調整) 
必須
アクションを適用した最新の日程調整オブジェクトです。
id
string <uuid>
必須
ID
name
string 
必須
名前
lengthMin
number 
必須
所要時間
client
object (企業担当者) 
必須
企業担当者のID
candidate
object (求職者) 
必須
求職者のID
proposablePeriods
array[object (時間帯) {2}] 
可選
候補日時として選択できる時間帯。proposedPeriodsとの併用は不可。
proposableWeeklyAvailableTimes
必須
place
string  | null 
必須
場所
placeInfo
enum<string> 
可選
場所の事前情報(online/offline)
列挙型:
offlineonline
information
string  | null 
必須
連絡事項
deadline
string <date-time>
可選
期日。ISO8601
cc
array[string]
必須
cc通知対象ユーザーのメールアドレス
status
enum<string> 
必須
調整ステータス
列挙型:
startedproposedselectedconfirmedcanceled
proposedPeriods
array[object (時間帯) {2}]  | null 
必須
候補日時
selectedPeriod
必須
希望日時
approvedPeriod
必須
確定した日時
links
object 
必須
URL
createdAt
string <date-time>
必須
作成日時
metadata
object 
可選
メタデータ
更新日時 2024-04-11 09:40:53
前へ
削除
Built with