Get this event stream's delivery history

GET https://{tenantDomain}/api/v2/event-streams/{id}/deliveries

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    eventstreams "github.com/auth0/go-auth0/management/management/eventstreams"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &eventstreams.ListEventStreamDeliveriesRequestParameters{
        Statuses: management.String(
            "statuses",
        ),
        EventTypes: management.String(
            "event_types",
        ),
        DateFrom: management.String(
            "date_from",
        ),
        DateTo: management.String(
            "date_to",
        ),
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
    }
    client.EventStreams.Deliveries.List(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.deliveries.list("id", {
        statuses: "statuses",
        eventTypes: "event_types",
        dateFrom: "date_from",
        dateTo: "date_to",
        from: "from",
        take: 1,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.deliveries.list("id", {
        statuses: "statuses",
        eventTypes: "event_types",
        dateFrom: "date_from",
        dateTo: "date_to",
        from: "from",
        take: 1,
    });
}
main();

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

import requests

url = "https://{tenantDomain}/api/v2/event-streams/{id}/deliveries"

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

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/event-streams/{id}/deliveries",
  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;
}

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

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/event-streams/{id}/deliveries")

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

[
  {
    "id": "<string>",
    "event_stream_id": "<string>",
    "status": "failed",
    "attempts": [
      {
        "status": "failed",
        "timestamp": "2023-11-07T05:31:56Z",
        "error_message": "<string>"
      }
    ],
    "event": {
      "id": "<string>",
      "source": "<string>",
      "specversion": "<string>",
      "type": "<string>",
      "time": "2023-11-07T05:31:56Z",
      "data": "<string>"
    }
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

id · string · requis

Unique identifier for the event stream.

Required string length: 26

Paramètres de requête

statuses · string

Comma-separated list of statuses by which to filter

event_types · string

Comma-separated list of event types by which to filter

date_from · string

An RFC-3339 date-time for redelivery start, inclusive. Does not allow sub-second precision.

Maximum string length: 20

date_to · string

An RFC-3339 date-time for redelivery end, exclusive. Does not allow sub-second precision.

Maximum string length: 20

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 50.

Plage requise: 1 <= x <= 100

Réponse

200

application/json

Event stream deliveries successfully retrieved.

id · string · requis

Unique identifier for the delivery

event_stream_id · string<event-stream-id> · requis

Unique identifier for the event stream.

Required string length: 26

status · enum<string> · requis

Delivery status

Options disponibles: failed

Maximum string length: 6

event_type · enum<string> · requis

Type of event

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

Maximum string length: 33

attempts · object[] · requis

Results of delivery attempts

Show child attributes

event · object

Event content. This will only be set if delivery failed.

Show child attributes