Retrieve Event

Retrieves the details of an existing event by its identifier.

GET/events/{eventId}

This endpoint retrieves the full details of the specified event. You can use it as part of your workflow to manually process undelivered events as needed.

  1. Call this endpoint with the event's ID. This ID returned as the items[].id property in the List Events endpoint response.
  2. Stedi returns the event details, including the event type, event status, creation date, and full event payload.
Authorization
RequiredHeader

A Stedi API Key for authentication.

Path Parameters

eventId
StringRegex pattern: ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The unique identifier for the event, formatted as evt_{UUID}.

Response

application/json
createdAt
StringRequiredFormat: date-time

An ISO 8601 timestamp of when the event was created.

eventPayload
ObjectRequired

The event payload Stedi delivers to event destinations.

Show attributes
v1Event
eventPayload.v1Event
ObjectRequired

A v1 thin event payload.

Show attributes
account
eventPayload.v1Event.account
StringRequired

Stedi account identifier (UUID).

created
eventPayload.v1Event.created
StringRequiredFormat: date-time

An ISO 8601 timestamp of when the event was created.

environment
eventPayload.v1Event.environment
StringRequired

The environment in which the event was produced.

Possible values
TEST
PRODUCTION
id
eventPayload.v1Event.id
String

An identifier for the event, formatted as evt_{UUID}.

object
eventPayload.v1Event.object
StringRequired

Object type discriminator. Identifies the schema version of this payload.

Possible values
v1.event
relatedResources
eventPayload.v1Event.relatedResources
Array of Objects

Other resources related to the event. Only present when there are related resources.

Array item
id
eventPayload.v1Event.relatedResources[].id
StringRequired

The resource identifier.

type
eventPayload.v1Event.relatedResources[].type
StringRequired

The resource type. Uses dot notation to indicate nested resources. For example, enrollment.document indicates a document associated with a transaction enrollment request.

resource
eventPayload.v1Event.resource
ObjectRequired

Information about the resource that triggered the event. You can use this information to retrieve additional information about the resource.

Show attributes
id
eventPayload.v1Event.resource.id
StringRequired

The resource identifier.

type
eventPayload.v1Event.resource.type
StringRequired

The resource type. Uses dot notation to indicate nested resources. For example, enrollment.document indicates a document associated with a transaction enrollment request.

type
eventPayload.v1Event.type
String

The event type in dot notation, such as enrollment.activated.

eventType
StringRequiredLength: 1 - 255

The type of event, such as enrollment.activated.

id
StringRequiredRegex pattern: ^[a-z]{3,5}_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The unique identifier for the event, formatted as evt_{UUID}.

status
StringRequired

The current status of the event. Can be:

  • DELIVERED: Stedi successfully delivered the event to all relevant event destinations.
  • PENDING: Stedi is still trying to deliver the event to one or more event destinations. Events may stay in this state for multiple days as Stedi automatically retries.
  • FAILED: Stedi couldn't deliver the event to at least one event destination and is no longer retrying. Deliveries to some event destinations may have been successful.
Possible values
PENDING
DELIVERED
FAILED