mirror of
https://github.com/caronc/apprise.git
synced 2025-06-30 22:41:04 +02:00
Created Notify_ifttt (markdown)
46
Notify_ifttt.md
Normal file
46
Notify_ifttt.md
Normal file
@ -0,0 +1,46 @@
|
|||||||
|
## IFTTT (If This Than That) Notifications
|
||||||
|
* **Source**: https://ifttt.com/
|
||||||
|
* **Icon Support**: No
|
||||||
|
* **Message Format**: Text
|
||||||
|
* **Message Limit**: 32768 Characters per message
|
||||||
|
|
||||||
|
### Account Setup
|
||||||
|
Creating a IFTTTT account is easy. Visit there website and create your free account.
|
||||||
|
|
||||||
|
Once you're hooked up, you'll want to visit [this URL](https://ifttt.com/services/maker_webhooks/settings) on Webhooks. This will be the gateway Apprise will use to signal any Applets you create. When you visit this page it will give you your API key in the form of a URL.
|
||||||
|
|
||||||
|
The URL might something like this:
|
||||||
|
```https://maker.ifttt.com/use/b1lUk7b9LpGakJARKBwRIZ```
|
||||||
|
|
||||||
|
This effectively equates to:
|
||||||
|
```https://maker.ifttt.com/use/{WebhookID}```
|
||||||
|
|
||||||
|
In the above example the **WebhookID** is ```b1lUk7b9LpGakJARKBwRIZ```. You will need this value!
|
||||||
|
|
||||||
|
### Syntax
|
||||||
|
Valid syntaxes are as follows:
|
||||||
|
* **ifttt**://**{WebhookID}**/**{Event}**/
|
||||||
|
* **ifttt**://**{WebhookID}**@**{Event}**/**{Value1}**/
|
||||||
|
* **ifttt**://**{WebhookID}**@**{Event}**/**{Value1}****{Value2}****{Value3}**/
|
||||||
|
|
||||||
|
By default you don't need to specify or override an ingredient (these are the **{{ValueX}}** entries). So the standard URL ```ifttt://{WebhookID}/{Event}/``` should work for everyone. By default the Notification you specify gets mapped to the Applet ingredients so:
|
||||||
|
* **{{Value1}}** = Notification Title
|
||||||
|
* **{{Value2}}** = Notification Body
|
||||||
|
* **{{Value3}}** = Notification Message Type (the text 'info', 'critical', etc)
|
||||||
|
|
||||||
|
There may be cases where you simply don't want to pass a notification message to your IFTTT web hook, You're goal is to just trigger the event (maybe it's going to flip a light switch for example). You can over-ride values like so (this disables the value entries - note that they must be lower-case!):
|
||||||
|
* **ifttt**://**{WebhookID}**@**{WebhookToken}**/**?value1=&value2=&value3=**
|
||||||
|
|
||||||
|
### Parameter Breakdown
|
||||||
|
| Variable | Required | Description
|
||||||
|
| ----------- | -------- | -----------
|
||||||
|
| WebhookID | Yes | Your webhooks API Key you got from [the settings area of the webhooks service itself](https://ifttt.com/services/maker_webhooks)
|
||||||
|
| Event | Yes | This is the **Event Name** you assigned to the Applet you created. This is the event plan on triggering through the webhook.
|
||||||
|
|
||||||
|
#### Example
|
||||||
|
Send a discord notification:
|
||||||
|
```bash
|
||||||
|
# Assuming our {WebhookID} is b1lUk7b9LpGakJARKBwRIZ
|
||||||
|
# Assuming our {Event} is sms_message
|
||||||
|
notify discord:///b1lUk7b9LpGakJARKBwRIZ@sms_message
|
||||||
|
```
|
Reference in New Issue
Block a user