イベントを購読

Server-Sent Events（SSE）経由でイベントをサブスクライブする

GET https://{tenantDomain}/api/v2/events

Server-Sent Events (SSE) を使用してイベントをサブスクライブ

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/events \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/events"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}/api/v2/events', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/api/v2/events"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/events")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/events")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "event": {
    "a0stream": "<string>",
    "a0tenant": "<string>",
    "data": {
      "object": {
        "connection_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "name": "<string>",
        "type": "connection",
        "external_id": "<string>"
      },
      "context": {
        "tenant": {
          "tenant_id": "<string>"
        },
        "client": {
          "id": "<string>",
          "metadata": {},
          "name": "<string>"
        },
        "connection": {
          "id": "<string>",
          "name": "<string>",
          "strategy": "<string>"
        },
        "request": {
          "geo": {
            "city_name": "<string>",
            "continent_code": "<string>",
            "country_code": "<string>",
            "country_name": "<string>",
            "latitude": 123,
            "longitude": 123,
            "subdivision_code": "<string>",
            "subdivision_name": "<string>",
            "time_zone": "<string>"
          },
          "hostname": "<string>",
          "ip": "<string>",
          "method": "<string>",
          "user_agent": "<string>",
          "custom_domain": "<string>"
        }
      }
    },
    "id": "<string>",
    "source": "<string>",
    "specversion": "<string>",
    "time": "2023-11-07T05:31:56Z",
    "type": "group.created",
    "a0purpose": "test"
  },
  "offset": "<string>",
  "type": "group.created"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

クエリパラメータ

from · string

ストリーム内の位置を表す不透明なトークン。指定しない場合、ストリームは最新のイベントから開始されます。

Maximum string length: 1024

from_timestamp · string

イベントのストリーミング開始位置を示す RFC-3339 タイムスタンプ。これは、カーソルを利用できない可能性がある初回クエリでのみ使用してください。以降のリクエストでは、より正確なカーソル（from）を使用してください。

Maximum string length: 20

event_type · enum<string>[]

受信するイベントタイプ。複数のタイプを指定する場合は、複数回指定してください（例: ?event_type=user.created&event_type=user.updated）。指定しない場合は、すべてのイベントタイプがストリーミングされます。 リッスンするイベントタイプ。複数のタイプを指定する場合は、複数回指定します（例: ?event_type=user.created&event_type=user.updated）。指定しない場合は、すべてのイベントタイプがストリーミングされます。

利用可能なオプション: group.created, group.deleted, group.member.added, group.member.deleted, group.role.assigned, group.role.deleted, group.updated, organization.connection.added, organization.connection.removed, organization.connection.updated, organization.created, organization.deleted, organization.group.role.assigned, organization.group.role.deleted, organization.member.added, organization.member.deleted, organization.member.role.assigned, organization.member.role.deleted, organization.updated, user.created, user.deleted, user.updated

レスポンス

200

text/event-stream

イベントストリームが正常に確立されました。

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Option 24

各 SSE data 行で配信される JSON ペイロード。type フィールドは SDK によって SSE の event フィールドから挿入されます。type による判別は、イベントの場合はイベントタイプ名、エラーの場合は "error"、カーソルのみの heartbeat の場合は "offset-only" です。

event · object · 必須

グループが作成されたときに発生するイベントを表します。

Show child attributes

offset · string · 必須

ストリーム内の位置を表す不透明なカーソル。再開するには、from クエリパラメーターとして渡します。

type · enum<string> · 必須

イベントタイプ（SSE の event フィールドから挿入）。

利用可能なオプション: group.created