Skip to content
Avaloi

Webhooks

Outbound webhooks are not built yet. Follow jobs with server-sent events or polling, and read notifications, until they arrive.

This feature is not built yet. This article says what works today.

Avaloi does not send outbound webhooks yet. There is no page to register a URL, and Avaloi makes no HTTP calls to your systems when something happens. You can still follow every change as it runs, because every change to a server is a job with an event stream.

What to do today

Follow one job. Every write that changes a server returns a job. Open GET /v1/jobs/{id}/events to receive server-sent events. The stream replays the events so far, then follows new ones until the job ends. If you cannot hold a connection open, poll GET /v1/jobs/{id} and read the job's state.

Follow a bulk action. A bulk action is a job group with one child per environment. Read GET /v1/job-groups/{id} for the per-site results.

Read notifications. Avaloi writes a notification when a job finishes, a deployment ships, site health changes, and for security and team events. List them with GET /v1/notifications and mark them read with PATCH /v1/notifications/{id}. The dashboard checks for new ones every 30 seconds while the tab is visible. See Notifications.

Read the activity log. GET /v1/companies/me/activity and GET /v1/sites/{id}/activity list what happened and who did it.

Scripts that follow a job should open the event stream rather than poll in a loop, so they stay under the rate limits.

Not yet

Outbound webhooks will arrive as one feature. When they do:

  • You will register a URL for your company and pick the event types it receives.
  • Avaloi will sign every delivery so you can check it came from Avaloi.
  • Avaloi will retry a delivery that fails.
  • A delivery log will show each attempt, the response, and the next retry.
  • You will send a test event to check your endpoint before real events flow.

Quick answers

Can Avaloi call my CI when a deploy finishes? Not yet. Have your CI follow the deploy job's event stream, or poll the job, until webhooks arrive.

Is there a way to get an email instead? Yes. Turn on email for the categories you want under notification preferences. See Notifications.

How long does a job's event stream last? Until the job ends. Open it again later and it replays the events from the start.

Still stuck?

Email [email protected] with your site name and what you tried, or send us a message.