diff --git a/docs/api.md b/docs/api.md index 85fa022..26dc22a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -9,16 +9,17 @@ With HTTP, make GET request to `http://[IP]/api/stats` ## Update Awtrix searches for an update every 1 Hour. If a new one is found it will be published to HA and in the stats. You can start the update with update button in HA or: -| Topic | URL | Payload/Body | HTTP Header | HTTP method | -| --- | --- | --- |--- |--- | -| `[PREFIX]/doupdate` |`http://[IP]/api/doupdate` | JSON | empty payload/body | POST | + +| Topic | URL | Payload/Body | HTTP Header | HTTP method | +| --- | --- | --- | --- | --- | +| `[PREFIX]/doupdate` |`http://[IP]/api/doupdate` | JSON | empty payload/body | POST | ## Add custom app create custom apps or notifications to display your own text and icons. Have a look at [this section](custom?id=custom-apps-and-notifications) -| Topic | URL | Payload/Body | HTTP Header | HTTP method | -| --- | --- | --- |--- |--- | +| Topic | URL | Payload/Body | Query parameters | HTTP method | +| --- | --- | --- | --- | --- | | `[PREFIX]/custom/[appname]` |`http://[IP]/api/custom` | JSON | name = [appname] | POST | ## Dismiss Notification @@ -184,6 +185,6 @@ Here's an example JSON object to start a timer for 1 hour, 30 minutes, and 10 se "minutes": 30, "seconds": 10, "sound": "friends" -} +} ```