Hierarchy

  • EventsApi

Constructors

Properties

configuration: Configuration
requestFactory: EventsApiRequestFactory
responseProcessor: EventsApiResponseProcessor

Methods

  • This endpoint allows you to publish events.

    Note: To utilize this endpoint with our client libraries, please ensure you are using the latest version released on or after July 1, 2025. Earlier versions do not support this functionality.

    Important: Upgrade to the latest client library version to use the updated endpoint at https://event-management-intake.{site}/api/v2/events. Older client library versions of the Post an event (v2) API send requests to a deprecated endpoint (https://api.{site}/api/v2/events).

    Only events with the change or alert category are in General Availability. For change events, see Change Tracking for more details.

    ❌ For use cases involving other event categories, use the V1 endpoint or reach out to support.

    ❌ Notifications are not yet supported for events sent to this endpoint. Use the V1 endpoint for notification functionality.

    Parameters

    Returns Promise<EventCreateResponsePayload>

Generated using TypeDoc