API: Automations & segments

The cleanest way to send multi-step WhatsApp sequences from external events: keep the flow logic in Nybero’s automation editor, and use the API only to say “this contact, this flow, now”. See the API overview for authentication and errors.

List automations — GET /v1/automations

curl -s https://app.nybero.com/api/v1/automations \
  -H "Authorization: Bearer $NYBERO_KEY"

[
  { "id": "91c2…", "name": "Webinar funnel", "active": true },
  { "id": "5aa0…", "name": "Welcome sequence", "active": false }
]

Grab the id of the flow you want to enrol into. Only active automations accept enrolments.

Enrol a contact — POST /v1/automations/{id}/enroll

Identify the contact by contact_id or phone:

curl -s https://app.nybero.com/api/v1/automations/91c2…/enroll \
  -H "Authorization: Bearer $NYBERO_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone": "+4915112345678"}'

{ "run_id": "c44d…", "automation_id": "91c2…", "contact_id": "0d9f…" }

This is the Manual / API enrolment path — it works regardless of the automation’s own trigger, so you can enrol into a keyword- or tag-triggered flow too. Enrolment is idempotent per automation version: enrolling the same contact twice returns 409 Conflict instead of running the flow twice.

The run then behaves like any other: steps execute in order, the 24-hour window rules apply to message steps, and the run is visible on the automation’s page in the app.

Tip

Two ways to start a flow from outside — pick by ownership: enrol via API when your system decides which flow runs; add a tag (POST /v1/contacts/{id}/tags, see Contacts) when you just want to mark the contact and let Nybero’s Tag is added triggers decide what happens. The tag route keeps more logic visible in Nybero.

Segments

Segments are dynamic contact lists defined in the app (Segments); the API reads them:

# All segments
curl -s https://app.nybero.com/api/v1/segments \
  -H "Authorization: Bearer $NYBERO_KEY"

# Who matches right now? (paginated: limit/offset)
curl -s "https://app.nybero.com/api/v1/segments/{id}/contacts?limit=100&offset=0" \
  -H "Authorization: Bearer $NYBERO_KEY"

Membership is evaluated live at request time, so the answer always reflects the current data — useful for syncing an audience into another tool or counting a funnel stage from your own dashboard.

Worked example: webinar platform → Nybero funnel

Your webinar tool fires a “registration” event; Nybero runs the whole reminder funnel:

1. On registration, your backend upserts the contact (POST /v1/contacts) with opt_in: true and attributes: {"webinar_date": "2026-08-01T18:00:00Z"}.
2. The same handler calls POST /v1/automations/{id}/enroll for the Webinar funnel automation.
3. The flow (built once in the editor, see the webinar recipe) sends the confirmation immediately and the template reminders 24 h and 1 h before start.
4. After the webinar, your platform tags attendees attended via the API — a Tag is added automation sends the replay to everyone else.