イベント取得

GEThttps://api.omise.co/events/:id

特定のイベントの詳細情報を取得します。このエンドポイントを使用して、イベントの詳細を確認し、webhook配信をデバッグし、webhookに送信されたデータを検証します。

---

リクエストパラメータ

必須 - 1フィールドパスパラメータ

▼

`id`STRING(required)

取得するイベントID。イベントIDはevnt_で始まり、テストモードではtest_が続きます。

Example:"evnt_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

取得成功

イベントをトリガーしたデータとwebhook配信情報を含む完全な詳細を持つイベントオブジェクトを返します。

イベントオブジェクトに含まれるもの:

• object - 文字列値 "event"
• id - イベント識別子 (evnt_*)
• livemode - 本番モードかテストモードかを示すブール値
• location - イベントを取得するためのAPIパス
• key - イベントタイプ（例：charge.complete）
• data - イベントをトリガーした完全なオブジェクト
• actor_uid - イベントをトリガーしたアクターのユーザーID
• user_uid - イベントに関連付けられたユーザーID
• team_uid - サブマーチャントID（Payfacのみ）
• webhook_deliveries - イベントのwebhook配信記録の配列
• created_at - イベント発生日時（ISO 8601）

401

認証エラー

認証に失敗しました。無効または不足しているAPIキー。

一般的な原因:

• Authorizationヘッダーがない
• 無効なシークレットキー
• シークレットキーの代わりにパブリックキーを使用している
• 不正なHTTP Basic Auth形式

404

見つかりません

イベントが見つからないか存在しません。

一般的な原因:

• 無効なイベントID
• 別のアカウントのイベントID
• テストモードと本番モードのキーが混在している
• イベントが90日以上前に作成された（イベントは90日間保持）

5xx

サーバーエラー

サーバー側でエラーが発生しました。まれですが、適切に処理する必要があります。

対処方法:

• 指数バックオフでリクエストをリトライ
• status.omise.coでサービスインシデントを確認
• 詳細なガイダンスについてはエラー処理を参照

---

コードサンプル

cURL

curl https://api.omise.co/events/evnt_test_5xuy4w91xqz7d1w9u0t \
  -u skey_test_5xuy4w91xqz7d1w9u0t:

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

event = Omise::Event.retrieve('evnt_test_5xuy4w91xqz7d1w9u0t')

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

event = omise.Event.retrieve('evnt_test_5xuy4w91xqz7d1w9u0t')

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const event = await omise.events.retrieve('evnt_test_5xuy4w91xqz7d1w9u0t');

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$event = OmiseEvent::retrieve('evnt_test_5xuy4w91xqz7d1w9u0t');

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

Event event = client.events().get("evnt_test_5xuy4w91xqz7d1w9u0t");

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var event = await client.Events.Get("evnt_test_5xuy4w91xqz7d1w9u0t");

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

event, _ := client.GetEvent("evnt_test_5xuy4w91xqz7d1w9u0t")

---

エラーと結果コード

一般的なエラーコード

コード	説明	解決方法
authentication_failure	無効なAPIキー	シークレットキーが正しいか確認
not_found	イベントが見つからない	イベントIDと正しいモード（test/live）を確認

Webhook配信ステータスコード

ステータス	説明
200	正常に配信および処理された
4xx	クライアントエラー（不正なリクエスト、認証失敗）
5xx	サーバーエラー（エンドポイントでエラーが発生）
null	配信失敗（タイムアウト、接続拒否）

---

🔑API認証情報

▼

試してみる

必須 - 1項目

▼

id(必須)

あなたのIP: ...読み込み中...