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

Note

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

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. You need further requirements to be able to use this module, see Requirements for details.

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

DEPRECATED

Removed in:

version 13.0.0

Why:

The typetalk service will be discontinued on Dec 2025. See https://nulab.com/blog/company-news/typetalk-sunsetting/.

Alternative:

There is none.

Synopsis

  • Send a message to typetalk using typetalk API.

Requirements

The below requirements are needed on the host that executes this module.

  • json

Parameters

Parameter

Comments

client_id

string / required

OAuth2 client ID.

client_secret

string / required

OAuth2 client secret.

msg

string / required

Message body.

topic

integer / required

Topic ID to post message.

Attributes

Attribute

Support

Description

check_mode

Support: none

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Returns details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Send a message to typetalk
  community.general.typetalk:
    client_id: 12345
    client_secret: 12345
    topic: 1
    msg: install completed

Status

  • This module will be removed in version 13.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Takashi Someda (@tksmd)