Webhooks

yStore exposes a single inbound webhook endpoint that can trigger Flow Manager flows from external systems — payment processors, ERPs, fulfillment services, or any HTTP-capable tool.

---

Endpoint

POST /yui/flow/webhook/{secret}

Parameter	Description
{secret}	The webhook secret configured on the flow's Webhook trigger node

---

How it works

1. Create a flow in yStore → Marketing → Flow Manager.
2. Set the trigger to Webhook.
3. Copy the generated secret from the trigger node settings.
4. Send a POST request to /yui/flow/webhook/{secret} from your external system.
5. The entire request body is available inside the flow as webhook payload variables.

---

Request format

The endpoint accepts any JSON body. The full payload is passed into the flow's variable context:

curl -X POST https://yourstore.com/yui/flow/webhook/abc123xyz \
  -H "Content-Type: application/json" \
  -d '{
    "event": "shipment.delivered",
    "order_number": "00042",
    "tracking_code": "CZ123456789SK"
  }'

Inside the flow, reference payload values as:

{{ webhook.event }}         → "shipment.delivered"
{{ webhook.order_number }}  → "00042"
{{ webhook.tracking_code }} → "CZ123456789SK"

---

Response

Status	Meaning
200 OK	Flow triggered successfully
403 Forbidden	Secret does not match any registered webhook trigger
404 Not Found	Webhook feature not enabled or flow disabled

---

Security

• The {secret} in the URL acts as a bearer token. Treat it like a password — do not expose it in client-side code or public repositories.
• Rotate the secret by editing the Webhook trigger node in the flow and updating your external system.
• Requests are not authenticated beyond the secret — use HTTPS to prevent interception.

Use cases

• Trigger a "shipment delivered" email when your fulfillment system confirms delivery
• Fire a restock notification flow when your warehouse system updates inventory
• Start a win-back sequence when a CRM marks a customer as churned

See Flow Manager for the full flow setup reference.