Create an event stream

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

Go

Go

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.EventStreamsCreateRequest{
        CreateEventStreamWebHookRequestContent: &management.CreateEventStreamWebHookRequestContent{
            Destination: &management.EventStreamWebhookDestination{
                Type: management.EventStreamWebhookDestinationTypeEnum(
                    "webhook",
                ),
                Configuration: &management.EventStreamWebhookConfiguration{
                    WebhookEndpoint: "webhook_endpoint",
                    WebhookAuthorization: &management.EventStreamWebhookAuthorizationResponse{
                        EventStreamWebhookBasicAuth: &management.EventStreamWebhookBasicAuth{
                            Method: management.EventStreamWebhookBasicAuthMethodEnum(
                                "basic",
                            ),
                            Username: "username",
                        },
                    },
                },
            },
        },
    }
    client.EventStreams.Create(
        context.TODO(),
        request,
    )
}

201

{
  "id": "<string>",
  "name": "<string>",
  "subscriptions": [
    {
      "event_type": "<string>"
    }
  ],
  "destination": {
    "configuration": {
      "webhook_endpoint": "<string>",
      "webhook_authorization": {
        "username": "<string>"
      }
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Body

application/jsonapplication/x-www-form-urlencoded

Option 1

Option 2

Option 3

destination · object · required

Show child attributes

name · string

Name of the event stream.

Required string length: 1 - 128

subscriptions · object[]

List of event types subscribed to in this stream.

Minimum array length: 1

Show child attributes

status · enum<string>

Indicates whether the event stream is actively forwarding events.

Available options: enabled, disabled

Maximum string length: 8

Response

201

application/json

Event Stream stream created successfully.

Option 1

Option 2

Option 3

id · string<event-stream-id>

Unique identifier for the event stream.

Required string length: 26

name · string

Name of the event stream.

Required string length: 1 - 128

subscriptions · object[]

List of event types subscribed to in this stream.

Minimum array length: 1

Show child attributes

destination · object

Show child attributes

status · enum<string>

Indicates whether the event stream is actively forwarding events.

Available options: enabled, disabled

Maximum string length: 8

created_at · string<date-time>

Timestamp when the event stream was created.

updated_at · string<date-time>

Timestamp when the event stream was last updated.