Passer au contenu principal
POST
https://{tenantDomain}/api/v2
/
event-streams
/
{id}
/
test
C#
using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.EventStreams.TestAsync(
            id: "id",
            request: new CreateEventStreamTestEventRequestContent {
                EventType = EventStreamTestEventTypeEnum.GroupCreated
            }
        );
    }

}
package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    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>",
        ),
    )
    request := &management.CreateEventStreamTestEventRequestContent{
        EventType: management.EventStreamTestEventTypeEnumUserCreated,
    }
    client.EventStreams.Test(
        context.TODO(),
        "id",
        request,
    )
}
package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.eventstreams.requests.CreateEventStreamTestEventRequestContent;
import com.auth0.client.mgmt.types.EventStreamTestEventTypeEnum;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.eventStreams().test(
            "id",
            CreateEventStreamTestEventRequestContent
                .builder()
                .eventType(EventStreamTestEventTypeEnum.GROUP_CREATED)
                .build()
        );
    }
}
<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\EventStreams\Requests\CreateEventStreamTestEventRequestContent;
use Auth0\SDK\API\Management\Types\EventStreamTestEventTypeEnum;

$client = new Management(
    token: '<token>',
);
$client->eventStreams->test(
    'id',
    new CreateEventStreamTestEventRequestContent([
        'eventType' => EventStreamTestEventTypeEnum::GroupCreated->value,
    ]),
);
from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.event_streams.test(
    id="id",
    event_type="group.created",
)
require "auth0"

client = Auth0::Management.new(token: "<token>")

client.event_streams.test(
  id: "id",
  event_type: "group.created"
)
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.test("id", {
        eventType: "user.created",
    });
}
main();
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.eventStreams.test("id", {
        eventType: "user.created",
    });
}
main();
curl --request POST \
  --url https://{tenantDomain}/api/v2/event-streams/{id}/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": {}
}'
{
  "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

​
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

Corps

The payload for sending a test event to an event stream.

​
event_type
enum<string>
requis

The type of event this test event represents.

Options disponibles:
connection.created,
connection.deleted,
connection.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
Maximum string length: 33
​
data
object

The raw payload of the test event.

Réponse

Test event successfully submitted.

Metadata about a specific attempt to deliver an event

​
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:
connection.created,
connection.deleted,
connection.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
Maximum string length: 33
​
attempts
object[]
requis

Results of delivery attempts

​
event
object

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