Live message events
A server-sent event stream of message status changes for the calling account, so a console page can update itself rather than polling.
Console sessions only. A stream is the wrong shape for an API key, which should ask for what it needs and hang up; a key that wants delivery news should register a webhook endpoint, which is durable, signed and retried, where this is neither.
The stream is a **hint that something changed, never the only place a change can be learned**. Events are dropped for a client that stops reading, and are lost entirely while a connection is down, so a consumer must reconcile against the list endpoints on reconnect rather than treating the stream as a ledger.
Events are ready once on connection, then message per change:
`` event: message data: {"object":"message.updated","id":"msg_...","channel":"email", "status":"delivered","carrier":"smtp-primary"} ``
A comment line is written every 25 seconds to keep intermediaries from closing an idle connection.
Example
curl https://api.woyra.io/v1/console/stream \
-H "Authorization: Bearer $WOYRA_KEY"Response
200 The stream. Stays open until the client or the server closes it.
Errors
| Status | Codes |
|---|---|
| 401 | authentication_required, invalid_api_key |
Also in Console
- POST /v1/auth/signup — Create an account and sign in
- POST /v1/auth/login — Sign in with email and password
- POST /v1/auth/logout — End the session
- GET /v1/auth/config — What a sign-in page needs before anyone signs in
- GET /v1/auth/me — The signed-in user, account and MFA state
- POST /v1/auth/mfa/verify — Finish signing in with a TOTP code or a recovery code
- POST /v1/auth/passkeys/login/begin — Start signing in with a passkey
- POST /v1/auth/passkeys/login/finish — Finish signing in with a passkey
- GET /v1/auth/passkeys — The signed-in user's passkeys
- POST /v1/auth/passkeys/register/begin — Start adding a passkey
- POST /v1/auth/passkeys/register/finish — Finish adding a passkey
- DELETE /v1/auth/passkeys/{id} — Remove a passkey
- POST /v1/auth/recovery_codes — Make a fresh set of recovery codes
- POST /v1/auth/mfa/enrol — Start TOTP enrolment
- POST /v1/auth/mfa/confirm — Confirm TOTP enrolment with a code
- DELETE /v1/auth/mfa — Disable TOTP
- POST /v1/auth/verify-email — Confirm an email address from its link
- POST /v1/auth/resend-verification — Send the verification email again
- POST /v1/auth/forgot-password — Request a password reset link
- POST /v1/auth/reset-password — Set a new password from a reset link
- POST /v1/auth/change-password — Change the password while signed in
- GET /v1/auth/invites/{token} — Describe an invitation before accepting it
- POST /v1/auth/invites/accept — Accept an invitation and sign in
- GET /v1/console/overview — Dashboard counts
- GET /v1/console/analytics — Daily series and the route view
- GET /v1/audit_events — The account's audit trail