Passer au contenu principal
GET
https://{tenantDomain}/api/v2
/
events
S’abonner aux événements au moyen de Server-Sent Events (SSE)
curl --request GET \
  --url https://{tenantDomain}/api/v2/events \
  --header 'Authorization: Bearer <token>'
{
  "event": {
    "a0stream": "<string>",
    "a0tenant": "<string>",
    "data": {
      "object": {
        "connection_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "name": "<string>",
        "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"
  },
  "offset": "<string>"
}

Autorisations

​
Authorization
string
header
requis

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

Paramètres de requête

​
from
string

Jeton opaque représentant une position dans le flux. S’il n’est pas fourni, le flux commencera à partir des événements les plus récents.

Maximum string length: 1024
​
from_timestamp
string

Horodatage RFC-3339 indiquant à partir de quel point commencer la diffusion des événements. À utiliser uniquement pour la requête initiale lorsqu’un curseur peut ne pas être disponible. Les requêtes suivantes doivent utiliser le curseur (from), car il sera plus précis.

Maximum string length: 20
​
event_type
enum<string>[]

Type(s) d’événement à écouter. Indiquez ce paramètre plusieurs fois pour plusieurs types (p. ex., ?event_type=user.created&event_type=user.updated). S’il n’est pas fourni, tous les types d’événements seront diffusés. Type(s) d’événement à écouter. Spécifiez ce paramètre plusieurs fois pour plusieurs types (par ex., ?event_type=user.created&event_type=user.updated). S’il n’est pas fourni, tous les types d’événements seront diffusés.

Options disponibles:
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

Réponse

Flux d’événements établi avec succès.

Le payload JSON transmis dans chaque ligne de données SSE. Le champ type est injecté à partir du champ event de SSE par le SDK. Selon la valeur de type : un nom de type d’événement pour les événements, "error" pour les erreurs et "offset-only" pour les heartbeats avec curseur uniquement.

​
event
object
requis

Représente un événement qui se produit lorsqu’un groupe est créé.

​
offset
string
requis

Curseur opaque représentant une position dans le flux. Passez-le comme paramètre de requête from pour reprendre.

​
type
enum<string>
requis

Le type d’événement (injecté depuis le champ d’événement SSE).

Options disponibles:
group.created