Saltar al contenido principal
GET
https://{tenantDomain}/api/v2
/
events
Suscribirse a eventos mediante eventos enviados por el servidor (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>"
}

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de consulta

​
from
string

Token opaco que representa la posición en el flujo. Si no se proporciona, el flujo comenzará con los eventos más recientes.

Maximum string length: 1024
​
from_timestamp
string

Marca de tiempo RFC-3339 que indica desde dónde comenzar a transmitir eventos. Solo debe usarse en la consulta inicial cuando puede que no haya un cursor disponible. Las solicitudes posteriores deben usar el cursor (from), ya que será más preciso.

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

Tipo(s) de evento que se deben escuchar. Especifíquelo varias veces para varios tipos (por ejemplo, ?event_type=user.created&event_type=user.updated). Si no se proporciona, se transmitirán todos los tipos de evento. Tipo(s) de evento que se deben escuchar. Especifíquelo varias veces para incluir varios tipos (por ejemplo, ?event_type=user.created&event_type=user.updated). Si no se proporciona, se transmitirán todos los tipos de eventos.

Opciones 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

Respuesta

Flujo de eventos establecido correctamente.

La carga útil JSON entregada en cada línea de datos de SSE. El SDK inyecta el campo type a partir del campo event de SSE. Se discrimina por type: un nombre de tipo de evento para los eventos, "error" para los errores y "offset-only" para los heartbeats de solo cursor.

​
event
object
requerido

Representa un evento que se produce cuando se crea un grupo.

​
offset
string
requerido

Cursor opaco que representa la posición en el flujo. Páselo como parámetro de consulta from para reanudar.

​
type
enum<string>
requerido

El tipo de evento (inyectado desde el campo event de SSE).

Opciones disponibles:
group.created