Skip to main content
POST
/
api
/
v1
/
events
/
trigger
Trigger event
curl --request POST \
  --url https://staging.api.rye.com/api/v1/events/trigger \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productUrl": "<string>"
}
'
{
  "id": "evt_1234567890",
  "type": "checkout_intent.offer_retrieved",
  "createdAt": "2026-03-25T00:00:00Z",
  "source": {
    "id": "ci_1234567890",
    "type": "checkout_intent"
  },
  "data": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs-test.rye.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Rye API key

Body

application/json

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 waiting for an upstream update.

​
productUrl
string
required

Product URL (e.g. https://flybyjing.com/products/sichuan-chili-crisp).

​
topic
enum<string>
required

The webhook event topic to trigger.

Available options:
product.updated

Response

Created

​
id
string
required

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

Example:

"evt_1234567890"

​
object
enum<string>
required
Available options:
event
​
type
required

Description of the event.

Refer to types of events for a list of possible values.

Available options:
checkout_intent.offer_retrieved,
checkout_intent.offer_failed,
checkout_intent.completed,
checkout_intent.order_failed
Example:

"checkout_intent.offer_retrieved"

​
createdAt
string
required

Timestamp of when the event was created.

Example:

"2026-03-25T00:00:00Z"

​
source
object
required

A reference to the object which triggered the event.

You should use the API to fetch the full object details.

​
data
object

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.