Delete Message

In this article

Overview

Use this Snap to delete one or messages you have sent to a Public Channel/Private Group/User based on their timestamps.

Prerequisites

Add valid Slack Scopes based on the intended operation. See Required Slack Scopes below for details.

Required Slack Scopes

Any action you want to perform within a Slack workspace, additionally needs appropriate Scopes assigned to your appSee the Scope and Permissions article in Slack API documentation for the complete list and each Account page under Configuring Slack Accounts for information on defining Scopes for your app.

To

Bot Token Accounts
(scope)

User Token Accounts
(user_scope)
Post messages in approved channels & conversationschat:writechat:write
Start direct messages with peopleim:writeim:write
Read direct messages based on their IDsim:readim:read
View lists of channels and users to select fromusers:readusers:read

Support for Ultra Pipelines

Works in Ultra Pipelines.

Limitations

Snaps in this Snap Pack use conditional display/hiding of fields. So, ensure that you always use the New Form UI (and not the classic UI) for the Snaps to function as designed/expected.

Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 0
  • Max: 1
  • Mapper
  • JSON Generator
  • Copy
  • Sort
  • Search (Slack)
A document containing one or more timestamps of the original messages to be deleted.
Output

Document

  • Min: 0
  • Max: 1
  • Mapper
  • JSON Formatter
  • CSV Parser

A document containing details of one or more messages deleted.

Snap Settings

Parameter NameData TypeDescriptionDefault ValueExample 
LabelString
Specify a name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.
N/A
Target TypeDrop-down list

Select an option from the following list of permitted Target Types and specify the corresponding details needed:

  • Public Channel. To delete the message sent to one of the public channels in the workspace. Requires Channel.
  • Private Channel/Group. To delete the message sent to a private channel or group within the workspace. You must be a participant of the respective channel or group. Requires Channel.
  • Users. To delete the message sent to one or more individual users. Requires Users.
Public ChannelPrivate Channel/Group
ChannelString/Expression/Suggestion

Required for Target Types - Public Channel and Private Channel/Group

Click the  icon and select a channel from the suggested values. To add more channels, enter comma-separated values manually in one of the following formats: 

  • #channel.name:<11-character alphanumeric channel ID> OR
  • #channel.name OR
  • <11-character alphanumeric channel ID>
N/A#testprivate:G019B3ETYMB
UsersString/Expression/Suggestion

Required for Target Type - Users

Click the  icon and select a recipient from the suggested values. To add more recipients, enter comma-separated values manually in one of the following formats: 

  • @user.name:<11-character alphanumeric user ID> OR
  • @user.name OR
  • @<11-character alphanumeric user ID>
N/A@user.name:W01A94P7MK1
TimestampString/Expression/SuggestionRequired. To delete one or more messages you sent earlier, enter or pass their Epoch timestamps separated by a comma.N/A1601469028.000100
Snap ExecutionDrop-down list

Select one of the three following modes in which the Snap executes:

  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps downstream from it.

Execute onlyValidate & Execute

Troubleshooting

ErrorReasonResolution

Failure: Unable to delete the message with the given target and timestamp, message_not_found

The Snap cannot locate the target message to delete it.

Ensure that the Channel and Timestamp provided correspond to a valid message that exists before running the Pipeline again.

Input error: Target (user/channel) missingYou have not supplied either the Channel or the Timestamp for the target message to delete it.Ensure that you provide the required parameters to delete the message before running the Pipeline again.

Examples

Locating a Sent Message Using Search Keywords and Deleting it

To delete a message that was sent, we can locate the sent message and delete it. The same can be done for multiple messages, at once. This example demonstrates how we can use the Search Snap to achieve this result.

This Pipeline uses a set of Pipeline Parameters as depicted in the following image.

We use the Send Message Snap to send a message defined as an expression to a Private Channel.  

Send Message SnapOutput


Search Snap supports a variety of search keywords, besides exact words, like wildcard search (using *, #, and so on), sender, or recipient of the messages and files. We use this feature to perform two different search operations and combine their results to see if our message is retrieved. 

So, after sending the message we use the Copy Snap to duplicate the output from Send Message Snap and initiate two Search operations - one based on the wildcard search and another on the sender's name/ID.

Search by wildcard textOutput

Search by SenderOutput

We combine these search results using a Join Snap to ensure the results contain the message we want to delete.

Join SnapOutput

Now, we connect a Mapper Snap to transform the contain search results data to contain only the Channel ID and the timestamps of the messages. This will enable us filter the results and identify the latest message that we want to delete.

Mapper Snap

Mapper Output

Connect a Delete Message Snap to the Mapper and pass the Channel and Timestamp values to it, to delete the message. The Snap deletes the message and shows the following output.

Delete Message SnapOutput

Download this Pipeline

Downloads

Important Steps to Successfully Reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified

File Example_Slack_Send_Search_Delete_Message.slp

Mar 11, 2022 by Subhajit Sengupta


Snap Pack History

 Click here to expand...

Release

Snap Pack Version 

Type

Updates

4.29main15993Stable

Enhanced the Slack - Send Message Snap with User Emails option for the Target Type dropdown list to send messages on Slack app using the user’s email.

4.28main14627

Stable

Upgraded with the latest SnapLogic Platform release.
4.27main12833StableUpgraded with the latest SnapLogic Platform release.
4.26main11181 LatestUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10994Latest

Improved the error messages in the Channel Operations Snap where the Snap fails with Null Pointer Exception when the account reference provided is invalid.

4.25main9554StableNo updates made.
4.24main8556StableNo updates made.

4.23

main7430

Stable

Initial release of the Snap Pack with the following Snaps and Accounts:


See Also