RYrye-com
Events

Retrieve event

Changed on

Retrieves an event by ID.

get/api/v1/events/{id}

Request

  • Base URL
    https://staging.api.rye.com
  • URL
    https://staging.api.rye.com/api/v1/events/{id}
  • Auth
    API key in header Authorization

Path parameters

idstring required

Response

The event

idstring required

Unique identifier for the event. This can be used as an idempotency key to avoid double-processing of the same underlying event.

object'event' required
createdAtstring required

Timestamp of when the event was created.

dataEventData

The event data payload. The concrete shape depends on source.type.

Refer to webhook event types for the payload shape associated with each source.type.

Example response

{
  "id": "evt_1234567890",
  "createdAt": "2026-03-25T00:00:00Z",
  "source": {
    "id": "ci_1234567890"
  }
}

Changes

  • 0b28c67737d3Revision changes
    • info

      the security scope events:read was added to the endpoint's security scheme bearerAuth

  • 6b20cee1f95dRevision changes
    • warning

      added the new product enum value to the / response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added to the response property anyOf list for the response status