Send a test event to an event stream

POST https://{tenantDomain}/api/v2/event-streams/{id}/test

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

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

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateEventStreamTestEventRequestContent{
        EventType: management.EventStreamTestEventTypeEnumUserCreated,
    }
    mgmt.EventStreams.Test(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.CreateEventStreamTestEventRequestContent;
import com.auth0.client.mgmt.types.EventStreamTestEventTypeEnum;

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

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

<?php

namespace Example;

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

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->eventStreams->test(
    'id',
    new CreateEventStreamTestEventRequestContent([
        'eventType' => EventStreamTestEventTypeEnum::GroupCreated->value,
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

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

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.event_streams.test(
  id: "id",
  event_type: "group.created"
)

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        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": {}
}'

202

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

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

Unique identifier for the event stream.

Required string length: 26

Body

application/jsonapplication/x-www-form-urlencoded

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

event_type · enum<string> · required

The type of event this test event represents.

Available options: 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.

Response

202

application/json

Test event successfully submitted.

Metadata about a specific attempt to deliver an event

id · string · required

Unique identifier for the delivery

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

Unique identifier for the event stream.

Required string length: 26

status · enum<string> · required

Delivery status

Available options: failed

Maximum string length: 6

event_type · enum<string> · required

Type of event

Available options: 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[] · required

Results of delivery attempts

Show child attributes

event · object

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

Show child attributes