Ambee Webhooks allow you to receive real-time push alerts for a monitored location. The push-based data delivery platform provides real-time air quality, pollen, weather data, wildfires, and natural disasters.
When an event occurs, Ambee Webhooks sends an HTTP request to an endpoint you configure rather than making an API call.
In addition to alerts, Ambee Webhooks also allows cloud-based data dumps for our datasets. We support FTP servers, Google Cloud Platform, Amazon S3 bucket, and Microsoft Azure.
Data dumps are currently available only with privileged access. To set this up, please contact our customer support.
Ambee Webhooks is an invite-only platform. Reach out to our team of experts to sign up for Webhooks and get started today!
Explore Ambee Webhooks for real-time environmental data alerts and make timely, informed decisions.
This refers to the URL where the client wants the data to be pushed whenever the condition meets the provided criteria. It acts as a trigger point for the server to push relevant information to the client's specified location, ensuring timely notification or action based on predefined criteria.
The header section is a crucial component of the HTTP request sent to Ambee's Webhooks endpoint. It provides additional details about the request, including authentication information such as API keys, bearer tokens, or username/password pairs (if Basic Auth is supported). The method used to include authentication credentials in the header varies depending on the chosen authentication method.
In the context of webhooks, a response pertains to the data transmitted back by the receiving application (your server) in reaction to a webhook notification. It's essential to recognize that webhooks typically facilitate one-way communication initiated by the source, such as Ambee, delivering information to your server for further processing or action.
Example: Here's a sample response following the setup of webhooks through the Ambee platform, with an endpoint URL provided for the pollen trigger.
{
"method": "POST",
"path": "/",
"query": {},
"client_ip": "65.2.83.128",
"url": "https://a0f6171d4c2b82d632bcfd46982566c6.m.pipedream.net/",
"headers": {
"host": "a0f6171d4c2b82d632bcfd46982566c6.m.pipedream.net",
"content-length": "235",
"user-agent": "python-requests/2.31.0",
"accept-encoding": "gzip, deflate",
"accept": "*/*",
"content-type": "application/json"
},
"bodyRaw": "[{"grass_pollen": 0, "tree_pollen": 184, "weed_pollen": 0}, {"grass_pollen": 0, "tree_pollen": 239, "weed_pollen": 0}, {"grass_pollen": 0, "tree_pollen": 85, "weed_pollen": 0}, {"grass_pollen": 0, "tree_pollen": 160, "weed_pollen": 0}]",
"body": [
{
"grass_pollen": 0,
"tree_pollen": 184,
"weed_pollen": 0
},
{
"grass_pollen": 0,
"tree_pollen": 239,
"weed_pollen": 0
},
{
"grass_pollen": 0,
"tree_pollen": 85,
"weed_pollen": 0
},
{
"grass_pollen": 0,
"tree_pollen": 160,
"weed_pollen": 0
}
]
}
Ambee Webhooks offers different authentication options to secure the data being sent to your designated endpoint. Here's a breakdown of the four options we mentioned along with the header section:
This option is the simplest but also the least secure. It means the receiving server isn't verified, so Ambee will send data to your endpoint URL without any checks, potentially exposing it to unauthorized access. If your request doesn't need authorization, choose No Auth from the Authorization dropdown list.
With API key auth, you send a key-value pair to the API either in the request headers or query parameters. In the request Authorization tab, select API Key from the Type list. Enter your key name and value, and select either Header or Query Params.
This method uses a bearer token for authentication, similar to an API key. The token, typically in the format "Authorization: Bearer < your_token_here >," is included in the request header. To implement this, select Bearer Token from the Authorization Type dropdown list and input your API key value in the Token field.
This method involves sending a verified username and password with your request. In the authentication tab, select Basic Auth from the Type dropdown list. Enter your API username and password in the Username and Password fields.
Found In the history section, the "status" indicates the outcome of the webhook request. There are three possible categories:
This status is returned when the user's conditions are met, indicating that the webhook request was successfully processed.
If there are no records matching the specified conditions, this status is returned. For example, if a condition like "Temp>30°C" doesn't match any records for the given hour.
This status is returned when an error occurs, either due to backend issues (such as Airflow DAG creation problems) or issues at the user’s end, like an incorrect URL.
Next
Setup Alerts
Yes
No