Eventを取得

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

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

---

🔑API認証情報

▼

---

リクエストパラメータ

Required - 1 fieldPath Parameters

▼

`id`STRING(required)

The event ID to retrieve. Event IDs start with evnt_ followed by test_ for test mode.

Example:"evnt_test_5xuy4w91xqz7d1w9u0t"

---

レスポンス

200

取得成功

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

Eventオブジェクトに含まれる内容:

• id - Event識別子（evnt_*）
• key - Eventタイプ（例: charge.complete）
• data - Eventをトリガーした完全なオブジェクト
• webhook_deliveries - ステータスとレスポンスを含むwebhook配信試行の配列
• created_at - Eventが発生した日時（ISO 8601）

401

認証されていません

認証に失敗しました。APIキーが無効または欠落しています。

一般的な原因:

• Authorizationヘッダーが欠落しています
• secret keyが無効です
• secret keyの代わりにpublic keyを使用しています
• HTTP Basic Auth形式が正しくありません

404

見つかりません

Eventが見つからないか、存在しません。

一般的な原因:

• 無効なEvent ID
• 別のアカウントのEvent ID
• testモードとliveモードのキーが混在しています
• Eventが90日以上前に作成されました（Eventは90日間保持されます）

---

コードサンプル

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キー	secret keyが正しいことを確認してください
not_found	Eventが見つかりません	Event IDを確認し、正しいモード（test/live）であることを確認してください

Webhook配信ステータスコード

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

---

試してみる

必須 - 1項目

▼

id(必須)