Get a specific event's delivery history

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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    client.EventStreams.Deliveries.GetHistory(
        context.TODO(),
        "id",
        "event_id",
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.deliveries.getHistory("id", "event_id");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.deliveries.getHistory("id", "event_id");
}
main();

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

import requests

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

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/{event_id}",
  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/{event_id}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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>"
  }
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

Unique identifier for the event stream.

Required string length: 26

event_id · string · 必須

Unique identifier for the event

Required string length: 26

レスポンス

200

application/json

Delivery history for event successfully retrieved.

Metadata about a specific attempt to deliver an event

id · string · 必須

Unique identifier for the delivery

event_stream_id · string<event-stream-id> · 必須

Unique identifier for the event stream.

Required string length: 26

status · enum<string> · 必須

Delivery status

利用可能なオプション: failed

Maximum string length: 6

event_type · enum<string> · 必須

Type of event

利用可能なオプション: 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[] · 必須

Results of delivery attempts

Show child attributes

event · object

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

Show child attributes