How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rye Events API

The Events API from Rye — 3 operation(s) for events.

Rye Events API is one of 13 APIs that Rye publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 3 operations across 3 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.5.

Requests are made against a single base URL, https://staging.api.rye.com.

3 operations 3 paths 16 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.5
Base URL
https://api.rye.com/api/v1/
Authentication
API Key
Contact
License
UNLICENSED
Terms of Service
Resource Areas
1

Authentication & Security 1

Rye Events API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (bearerAuth).

  • bearerAuth — Rye API key

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Events 3
GET
/api/v1/events
List events
List 3 params → 200401404422
GET
/api/v1/events/{id}
Retrieve event
Get 1 param → 200401404422500
POST
/api/v1/events/trigger
Trigger event
Trigger body → 201401404422500

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Event (6 properties), ValidateError (5 properties), NotFoundError (3 properties), RuntimeError (3 properties). Each schema is shown below with its type and property counts.

ProductEventType
string
EventSourceType
string
FieldErrors
object
NotFoundError
object
3 properties 2 required
ShipmentEventType
string
WebhookEndpointEventType
string
ValidateError
object
5 properties 4 required
EventSource
object
A reference to the object which triggered the event. You should use the API to fetch the full object details.
2 properties 2 required
EventData
object
The event data payload. The concrete shape depends on source.type. Refer to [webhook event types](https://docs.rye.com/api-v2/webhooks/types) for the payload s…
RuntimeError
object
3 properties 2 required
EventListResponse
object
2 properties 2 required
AuthenticationError
object
3 properties 2 required
EventTriggerRequest
object
Request body for POST /api/v1/events/trigger. Generates a webhook event for the product at the given URL so integrations can be exercised on demand without wai…
2 properties 2 required
Event
object
6 properties 5 required
EventType
CheckoutIntentEventType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rye-events-api-openapi.yml Raw ↑

Other APIs Rye publishes across the network.

Rye Betas API
Rye Billing API
Rye Brands API
Rye Checkout Intents API
Rye Commissions API
Rye Merchant Connectors API
Rye Orders API
Rye Payment Gateways API
Rye Products API
Rye Returns API
Rye Shipments API
Rye Test Helpers API
Where this information came from

This is an independent, third-party profile of Rye Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.