Birdie0/ifttt-webhooks-extended-guide.md

## ifttt-webhooks-extended-guide.md

      
    Raw
  

              ifttt-webhooks-extended-guide.md
            
          
    ⚠️ This gist is no longer updated! For maintained, improved and even more extended guide click here.

How to use Discord Webhook

It's a JSON

First, learn JSON. It's not programming language, not even close.
Just follow syntax rules and you will be fine.
Recommended sources:

Learn X in Y minutes | Where X=json
JSON official site

Structure of Webhook Body

Second, learn the structure.
All root elements are optional unless stated otherwise. Body have to include content or embeds, otherwise request will fail.

element : [data type] - description


[string] - text

[website url] - ex.: https://google.com

[image url] - ex.: https://www.w3schools.com/html/pic_mountain.jpg


[array] - comma-separated elements. ex.: [1, 2, 3, 4]


[number] - ex. 1337, 420.69, -1000, etc.


[boolean] - can be true or false only.


[object] - can include key: values


username : [string] - overrides the default username of the webhook


avatar_url : [image url] - overrides the default avatar of the webhook


content : [string] - simple message, the message contains (up to 2000 characters)


embeds : [array] - array of embed objects. That means, you can use more than one in the same body

author : [object] - embed author object

name : [string] - name of author
url : [website url] - url of author. If name was used, it becomes a hyperlink
icon_url : [image url] - url of author icon


title : [string] - title of embed
url : [website url] - url of embed. If title was used, it becomes hyperlink
description : [string] - description text
color : [number] - color code of the embed. You have to use Decimal numeral system, not Hexadecimal. Use color picker
fields : [array] - array of embed field objects

name : [string] - name of the field
value : [string] - value of the field
inline : [boolean] - if true, fields will be displayed in same line, but there can only be 3 max in same line or 2 max if you used thumbnail


thumbnail : [object] - embed thumbnail object

url : [image url] - url of thumbnail


image : [object] - embed image object

url : [image url] - image url


footer : [object] - embed footer object

text : [string] - footer text, doesn't support Markdown
icon_url : [image url] - url of footer icon


Example for a webhook

{
  "username": "Webhook",
  "avatar_url": "https://i.imgur.com/4M34hi2.png",
  "content": "Text message. Up to 2000 characters.",
  "embeds": [
    {
      "author": {
        "name": "Birdie♫",
        "url": "https://www.reddit.com/r/cats/",
        "icon_url": "https://i.imgur.com/R66g1Pe.jpg"
      },
      "title": "Title",
      "url": "https://google.com/",
      "description": "Text message. You can use Markdown here. *Italic* **bold** __underline__ ~~strikeout~~ [hyperlink](https://google.com) `code`",
      "color": 15258703,
      "fields": [
        {
          "name": "Text",
          "value": "More text",
          "inline": true
        },
        {
          "name": "Even more text",
          "value": "Yup",
          "inline": true
        },
        {
          "name": "Use `\"inline\": true` parameter, if you want to display fields in the same line.",
          "value": "okay..."
        },
        {
          "name": "Thanks!",
          "value": "You're welcome :wink:"
        }
      ],
      "thumbnail": {
        "url": "https://upload.wikimedia.org/wikipedia/commons/3/38/4-Nature-Wallpapers-2014-1_ukaavUI.jpg"
      },
      "image": {
        "url": "https://upload.wikimedia.org/wikipedia/commons/5/5a/A_picture_from_China_every_day_108.jpg"
      },
      "footer": {
        "text": "Woah! So cool! :smirk:",
        "icon_url": "https://i.imgur.com/fKL31aD.jpg"
      }
    }
  ]
}
And how it looks


Getting Started

Account on IFTTT

Visit IFTTT and create an account (if you haven't one).
Webhook on Discord


Go to Server settings -> Webhooks -> Create Webhook
Setup name, avatar and the channel, where it will be posted. Copy Webhook URL. Do not share! Very dangerous!
Click Save and then the Done button

Creating an Applet

If this


Go to My Applets -> New Applet
Click [+]this
Choose a service. In theory, you could use all of them
Choose the trigger. Read the description below every trigger and choose the needed one
Complete trigger fields. There can be more than one step. Read the descriptions and examples

Then that


Click [+]that
Choose the action service. You need Webhooks. Use the search bar
Choose action. Choose Make a web request
Paste your Webhook URL to URL field
Select POST method
Select application/json content type
And now the hardest part™. You need to create your JSON body. Follow the structure, use it as an example and don't forget about common sense. Press + Ingredient button and put the Ingredients into appropriate fields. If something says URL put it in "url":"{{URL}}", if something says ImageURL, try to put that into "image": {"url":"{{ImageURL}}"}.  There's no universal solution
Click Create Action and then Finish
Done!

Tips


Use this awesome website to generate valid json wirh built-in preview: Discohook, also you can send webhooks to your server with it if you just wan't fancy embed in your channel without any automatization.
Don't forget to check your JSON body with a JSON validator. If you don't know any use one of these:

JSON Formatter
JSONLint
JSON Editor Online


If the webhook doesn't work, check log for errors. My Applets -> choose applet -> click gear -> View activity log. Maker error means your JSON body has errors.
Discord has built-in embeds for Twitter, Youtube and other sites so you can just add the link to the webhook: {"content": "{{Link}}"}.

Examples

Check https://birdie0.github.io/discord-webhooks-guide Examples section!