Documentation Index
Fetch the complete documentation index at: https://docs.pocketflows.com/llms.txt
Use this file to discover all available pages before exploring further.
Customer Identification
Option 1: Customer ID as a string
{
"name": "purchase_completed",
"customer": "cus_abc123"
}
Option 2: Customer as an object with id
{
"name": "purchase_completed",
"customer": {
"id": "cus_abc123"
}
}
Purchase Amount
The shape of the payload depends on your purchase_amount_path configuration.
Flat key — purchase_amount_path: "order_amount"
{
"name": "purchase_completed",
"customer": "cus_abc123",
"order_amount": 49.99
}
Nested key — purchase_amount_path: "order.amount"
{
"name": "purchase_completed",
"customer": "cus_abc123",
"order": {
"amount": 49.99
}
}
Deeply nested — purchase_amount_path: "order.total.amount"
{
"name": "purchase_completed",
"customer": "cus_abc123",
"order": {
"total": {
"amount": 49.99
}
}
}
Referencing Event by Public ID
Instead of the event name string, partners can also use the project-defined
event’s public ID directly:
{
"name": "pde_xyz789",
"customer": "cus_abc123",
"order_amount": 49.99
}