You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.general.flowdock module – Send a message to a flowdock

Note

This module is part of the community.general collection (version 6.6.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.flowdock.

Synopsis

• Send a message to a flowdock team inbox or chat using the push API (see https://www.flowdock.com/api/team-inbox and https://www.flowdock.com/api/chat)

Parameters

Parameter	Comments
external_user_name string	(chat only - required) Name of the “user” sending the message
from_address string	(inbox only - required) Email address of the message sender
from_name string	(inbox only) Name of the message sender
link string	(inbox only) Link associated with the message. This will be used to link the message subject in Team Inbox.
msg string / required	Content of the message
project string	(inbox only) Human readable identifier for more detailed message categorization
reply_to string	(inbox only) Email address for replies
source string	(inbox only - required) Human readable identifier of the application that uses the Flowdock API
subject string	(inbox only - required) Subject line of the message
tags string	tags of the message, separated by commas
token string / required	API token.
type string / required	Whether to post to ‘inbox’ or ‘chat’ Choices: "inbox" "chat"
validate_certs boolean	If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Choices: false true ← (default)

Attributes

Attribute	Support	Description
check_mode	Support: full	Can run in check_mode and return changed status prediction without modifying target.
diff_mode	Support: none	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Send a message to a flowdock
  community.general.flowdock:
    type: inbox
    token: AAAAAA
    from_address: [email protected]
    source: my cool app
    msg: test from ansible
    subject: test subject

- name: Send a message to a flowdock
  community.general.flowdock:
    type: chat
    token: AAAAAA
    external_user_name: testuser
    msg: test from ansible
    tags: tag1,tag2,tag3

Authors

• Matt Coddington (@mcodd)

Collection links

Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication