Skip to main content
CONNECT GUIDES

Send WeatherX alerts to your inbox

Press one button in your email and the alerts arrive at the address you signed up with. Nothing to install, nothing to paste, nobody to ask.

All connect guides

This is the shortest of the seven. We already hold your address and we have already proved it — your API key went to it, and it came back in use — so there is no other company in the middle, no screen to approve and nothing to paste. What is left is you saying yes.

Your emailpress Turn on email alertsOur pagepress the buttonWeatherXwatches the placeevery alert from then on, with no further work

The steps

  1. In the WeatherX email, find the Email row and press Turn on email alerts.

  2. A WeatherX page opens and names your place. Check it is the right one.

  3. Press the button on that page. That press is what turns the alerts on — opening the link does not.

  4. The page says the alerts are on. They start at the next ten-minute look. That line is the confirmation; there is nothing else to fill in.

Turn on email alertsour pageSend weather alerts forAcme depotto the address you signed up with.Turn on email alerts
The page the link opens. It names your place, and it has one button.

Check it works

You do not have to wait for weather. We can send one real alert to your inbox now, so you know the whole path works: write to support@weatherx.earth and name the place.

It arrives as light rain half an hour away, and it says on its face that it is a test — in the subject line, and in the first line of the message — so nobody can mistake it for weather.

It goes to every destination on that place, not only to your inbox. If the place already writes into your team's chat, your team sees the test too. Say so first, or ask for the test on a place that has only your email on it.

If you write code, you can send it yourself with one call. It is in the second half of this page, with the rest of the API.

What arrives, and when

We look at your place every ten minutes. You get one message when weather is coming or has started, and one when it has passed. A quiet week is a quiet inbox — nothing arrives to say that nothing is happening.

From WeatherX, to the address you signed up with

Subject: Rain starting at Acme depot, in 20 minutes

PREPARE — rain — Acme depot

The rain is expected to reach the place at 12:20 UTC, in 20 minutes.

The nearest one is about 12 km away, coming from the SW.

How hard: light — about 1.2 millimetres of rain in an hour.

We looked at the place at 12:00 UTC.

Stop these alerts: https://weatherx.earth/guide/email/

The subject says which weather, which place and how long there is. Inside, the first line is the decision: STOP means it is at the place now or within twenty minutes, PREPARE means it is coming, ALL CLEAR means it has passed.

The last line of every message points back at this page. It is a link to a manual and not a switch: opening it changes nothing, so an alert that is forwarded, quoted or read by a spam filter carries nothing anybody can act on.

Where it comes from

  • It comes from the same sender that sent you your API key. If you keep an allow list, that is the address to put on it.
  • If the first one lands in spam, mark it as not spam once. Weather alerts are worth nothing in a folder nobody opens.
  • One message per event per place. Two places that both see the same storm send two messages, because they are two decisions.

How to stop it

There is nothing to switch off at anybody else's end, because there is nobody else: no app to remove, no webhook to delete, no workspace to leave. The way to stop it is in the next section, and it needs nobody.

Why it works this way

Three questions this page is often asked. None of them changes what you press.

Mail systems open every link in a message before you do, to check it. A link that switched your alerts on by being opened would switch them on for a scanner, not for you — and it would spend your single-use ticket doing it. So the link only shows the page, and the press on the page is what counts. The link works once and lasts seven days.

Why only the address you signed up with

We send these alerts to the address the account was created with, and to no other one. That address is the only one we have ever proved: your key went to it, and it came back in use.

Sending to another address — a colleague's, a shared mailbox, a list — would mean mailing somebody who never asked us for anything. That needs its own proof of ownership, we have not built it, and until we do we refuse rather than guess. Name a different address in the call and you get a plain refusal, with nothing on your account changed.

What works today: a forwarding rule, or a group address, inside your own mail system. It is your mail from the moment it arrives, and you can do what you like with it.

Why nothing in an alert can switch it off

Every message ends with a line pointing at this page, and that line opens a manual, not a switch. An alert travels through mail servers, spam filters and forwarded threads, so it carries no key and no ticket of any kind: there is nothing in one for anybody to pick up, and nothing that acts by being opened.

How to stop everything, without asking anybody

Your WeatherX email carries a Stop link at the bottom. Open it, and press the button on the page it shows. It stops every alert for that place and turns off every destination on it, at any hour. It needs no key and no reply.

Write to support@weatherx.earth, and ask us to take one destination off and leave the rest running.

That is the whole job

If you have connected the destination and you know how to stop it, you are done. You can stop reading here.

Everything below this line is for a developer — somebody who makes calls to our API from a program. It is a different way to do some of the same things, and one thing more. Nobody needs it to receive alerts.

Everything here needs your API key

Send it as an X-API-Key header. It is the key from your welcome message, and it never travels in a connect link — the two are separate on purpose.

Send yourself a real alert, now

You do not have to wait for weather. One call sends a real alert through the real senders:

POST /portal/sites/<place id>/test
X-API-Key: wx_live_…

It arrives as light rain half an hour away, and it says on its face that it is a test — in the first line of the message — so nobody can mistake it for weather. One a minute, twenty a day.

It goes to every destination on that place, not only to the one this page is about. If the place already writes into your team's chat, your team sees the test too. Say so first, or test on a place that has only one destination on it.

Take one destination off, and leave the rest

The Stop link above turns off everything at once. This takes off one and leaves the place watched. Ask for the list, then delete the one you mean:

GET /portal/sites/<place id>/channels
DELETE /portal/channels/<id>
X-API-Key: wx_live_…

Everything else on that place carries on receiving.

If the Email link has been used, or is older than seven days, or the message it came in was deleted, mint another:

POST /portal/sites/<place id>/connect/email
X-API-Key: wx_live_…

{"kind": "email", "url": "https://…", "expires_at": "…"}

Open the url in a browser and it behaves exactly like the button in your message — the key stays in the header and never travels in the link. Asking again for the same place and the same destination replaces the live link rather than adding a second one, so the newest one you were given is the one that works.

The message as fields, not sentences

This destination receives the alert written out as sentences, because a person reads it. A program usually wants the numbers instead — how far away, which direction, how far ahead the forecast was. That is a second destination kind, and it has its own page: alerts to your own server. A place can carry both at once.

If you would rather wire it up

The same thing from the API, for whoever is connecting places in bulk rather than pressing a button. Every call goes to the address this page is on and carries your API key in the X-API-Key header.

  1. Find the place. Read the id of the one you want.

    GET /portal/sites X-API-Key: wx_live_…
  2. Ask for email. One call, and no body to send: we use the address the account was created with.

    POST /portal/sites/<place id>/channels/email X-API-Key: wx_live_…
  3. Read the answer. It names the address the alerts will go to, so you can see it is the right one.

    {"id": 12, "kind": "email", "url": "mailto:you@yourcompany.example", "enabled": true, "secret": null}

Asking twice gives back the destination that is already there. It never makes a second one, so a double press cannot double your mail.

The steps on this page were checked on . The example message is not a copy — it is drawn by the same code that writes your alerts, so it is current on every visit. If the messages you receive no longer look like the ones on this page, write to support@weatherx.earth and tell us. A person reads it.

This page holds no key, sets no cookie and runs nothing that follows you.