Quickstart: from account to first operation

Create a Flowyn account and an API key, send your first request, keep the id it returns, and read the result back.

This page takes you from zero to one completed Flowyn operation in the test environment. The same path works for documents, events, jobs, schedules, monitors, flags, and agent runs.

1. Create an account and workspace

Sign up at the dashboard. Every workspace has a test environment and a live environment. Resources in one are never visible in the other.

2. Create an API key

In the dashboard, open API keys and create a key for the test environment. It starts with flw_test_ and is shown once. Store it as FLOWYN_API_KEY in your server environment. Never ship it in client code.

export FLOWYN_API_KEY=flw_test_••••

3. Create a delivery endpoint

Create an HTTPS endpoint subscribed to the event type, using your own receiver URL. Creation returns HTTP 200. Save its id and store the signing secret securely; it is shown once.

curl -X POST https://api.flowyn.dev/v1/endpoints \
  -H "Authorization: Bearer $FLOWYN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: orders-endpoint-001" \
  -d '{
    "name": "Orders",
    "url": "https://hooks.example.com/orders",
    "event_types": [
      "order.completed"
    ]
  }'

4. Make your first request

Send an event. Flowyn stores it and returns HTTP 202 before any delivery is attempted.

curl -X POST https://api.flowyn.dev/v1/events \
  -H "Authorization: Bearer $FLOWYN_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-123-completed" \
  -d '{
    "type": "order.completed",
    "payload": {
      "order_id": "ord_123"
    }
  }'

5. Keep the id

Every create returns an id, a UUID. It is how you, the dashboard, and your agent refer to this operation from now on. Every response also carries a request_id you can quote to support.

6. Read the status

Read the resource back. Status changes are explicit, and every delivery attempt is recorded.

curl https://api.flowyn.dev/v1/events/0f8e4a52-3c1d-4e7b-9a26-5d1b7c3e9f10 \
  -H "Authorization: Bearer $FLOWYN_API_KEY"

curl https://api.flowyn.dev/v1/events/0f8e4a52-3c1d-4e7b-9a26-5d1b7c3e9f10/attempts \
  -H "Authorization: Bearer $FLOWYN_API_KEY"

7. Use the result

For events, the result is the delivery status and its attempts. For jobs, the terminal status and the attempts. For documents, the output files of the file job. For monitors, the latest result and any open incident. For flags, the value and reason in the evaluation response itself.

8. Errors and retries

A failed delivery or HTTP call does not fail your request: it is recorded as an attempt and retried within a finite policy. Errors in your own request come back as JSON with a type, a code, and a message. See Errors and Idempotency and retries.

Next step

Pick a product: Parse a PDF, Run a durable HTTP job, Deliver a webhook, Monitor an endpoint, Evaluate a flag, or Record an agent run. Or try the Playground first.