Skip to content

Extend Slack notification to support attachments#1716

Closed
aidan- wants to merge 1 commit intoFlexget:developfrom
aidan-:develop
Closed

Extend Slack notification to support attachments#1716
aidan- wants to merge 1 commit intoFlexget:developfrom
aidan-:develop

Conversation

@aidan-
Copy link
Copy Markdown
Contributor

@aidan- aidan- commented Mar 4, 2017

Motivation for changes:

Detailed changes:

  • modify flexget/plugins/notifiers/slack.py and add the additional attachments schema.
  • send the new attachment field in the notification payload

Config usage:

Extended from the existing example on the wiki:

tasks:
  move-test:
    rss: <redacted>
    imdb_lookup: yes
    imdb:
      min_year: 2016
    notify:
      entries:
        message: >
          {{task}} - Download started:
          {%- if imdb_name is defined %}
          {%- if imdb_url is defined %}
          <{{imdb_url}}|{{imdb_name}} {{imdb_year}}>
          {%- else %}
          {{imdb_name}} {{imdb_year}}
          {%- endif %}
          - {{quality}}
          {%- else -%}
          {{title}}
          {%- endif %}
        via:
          - slack:
              web_hook_url: <redacted>
              attachments:
                - image_url: '{{imdb_photo}}'
                - title: '{{imdb_name}} ({{imdb_year}})'
                  title_link: '{{imdb_url}}'
                  fallback: '{{imdb_name}} {{imdb_year}}'
                  text: '{{imdb_plot_outline}}'
                  color: "#3AA3E3"
                  footer: Flexget download
                  footer_icon: 'https://flexget.com/attachments/LogoContest/PastedGraphic-3.png'
                  fields:
                    - title: Votes
                      value: '{{imdb_votes}}'
                      short: true
                    - title: Score
                      value: '{{imdb_score}}'
                      short: true
                    - title: Genres
                      value: '{{imdb_genres|join(", ")}}'
                      short: true
                    - title: Rating
                      value: '{{imdb_mpaa_rating}}'
                      short: true
                    - title: Actors
                      value: >
                        {% for key, value in imdb_actors.iteritems() %}
                        {{value}}{% if not loop.last %},{% endif %}
                        {% endfor %}
                      short: false

Output:

A picture of the above config's output in slack:
screen shot 2017-03-04 at 3 48 00 pm

To Do:

liiight
liiight reviewed Mar 4, 2017
View reviewed changes
flexget/plugins/notifiers/slack.py
'icon_emoji': {'type': 'string'},
'icon_url': {'type': 'string', 'format': 'url'}
'icon_url': {'type': 'string', 'format': 'url'},
'attachments': {
Copy link
Copy Markdown
Member

@liiight liiight Mar 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Attachments schema should have some required fields according to slack docs if I remember correctly.

Copy link
Copy Markdown
Member

@liiight liiight Mar 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also I'd consider some default values for some of the more crucial fields

Copy link
Copy Markdown
Contributor Author

@aidan- aidan- Mar 4, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just read over the documentation, it doesn't look like any of the fields are mandatory? This is shown in my example config which is actually two attachments (first being the picture, second being the content).

I'm also not sure what the benefit would be in setting defaults. My example config relies heavily on imdb_lookup but I can imagine we can't assume people are using that plugin let alone want to use attachments instead of a basic message.

@liiight
Copy link
Copy Markdown
Member

liiight commented Mar 5, 2017

https://api.slack.com/docs/message-attachments#attachment_structure
Looks like there are several required fields, anything that isn't listed as optional.

About defaults, it's perfectly valid to use imdb lookup data as defaults, we do that with other templates as well. Just make sure to doc it properly.

@liiight
Copy link
Copy Markdown
Member

liiight commented Mar 26, 2017

You wanna update this?

@liiight
Copy link
Copy Markdown
Member

liiight commented Apr 18, 2017

Reopen if relevant

@liiight liiight closed this Apr 18, 2017
@rbraunschweig rbraunschweig mentioned this pull request Jul 31, 2018
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@liiight liiight liiight left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@aidan- @liiight