SA.Automate.WeatherApi 1.0.4

SA.Automate.WeatherApi

WeatherAPI.com connection types and actions for Umbraco Automate. Get the current weather or today's forecast for a location as part of an automation workflow.

What is WeatherAPI.com?

WeatherAPI.com is a JSON/XML weather API that provides current weather, forecasts, and historical weather for locations worldwide, looked up by city name, postcode/zip, IP address, or latitude/longitude. The free plan is suitable for commercial use.

What can this be used for?

This package is useful when you want current weather data inside an Umbraco Automate workflow, for example:

• Conditional content: branch a workflow based on the current conditions at a location.
• Enriching notifications: include the current temperature or conditions in a message sent by another action.
• Logging/reporting: record weather conditions alongside other workflow data.

Installation

dotnet add package SA.Automate.WeatherApi

No further setup required. The composer registers itself automatically via Umbraco's IComposer discovery.

Connection types

This package registers a single WeatherAPI.com connection type:

• API Key: optional. Overrides the globally configured API key for this connection. Leave blank to use the default key configured in appsettings.json.

Setup

1. Configure your API key

Get a free API key from weatherapi.com and set it as the default in your appsettings.json (or appsettings.Production.json); individual connections can still override it with their own key:

{
  "Umbraco": {
    "Automate": {
      "Providers": {
        "SA.Automate.WeatherApi": {
          "ApiKey": "your-api-key",
          "Culture": "en-GB"
        }
      }
    }
  }
}

Culture is optional and sets the default culture (e.g. en-GB, fr-FR) used to localize weather condition text across all actions. Leave it unset to default to English. An action's own Culture field always overrides this.

2. Create the connection in the backoffice

1. Go to Automate → Connections and create a new WeatherAPI.com connection.
2. Give the connection a name. Leave API Key blank to use the default configured in appsettings.json, or enter a different key for this connection.
3. Click Test connection to verify. This requests the current weather for a known location to confirm the API key is valid.

Tip: You only need multiple connections if different workflows should use different API keys.

Usage

Get Current Weather

Add the Get Current Weather action to any automation and select the connection to use. Available fields:

The action outputs the following, which can be referenced via bindings in later workflow steps:

Get Today's Weather

Add the Get Today's Weather action to any automation and select the connection to use. Available fields:

The action outputs the following, which can be referenced via bindings in later workflow steps:

Compatibility

Links

• Source code
• Report an issue
• WeatherAPI.com documentation