Skip to main content

Search Messages

SearchMessages searches messages in a workspace.

It calls GET https://slack.com/api/search.messages.

The activity has 4 tabs: Configuration, Auth, Input, and Output.

Configuration

FieldRequiredDescription
NameOptionalName of the step, should be unique within this workflow.
DescriptionOptionalDescribe the purpose or function of this step.
Result CountOptionalMaximum number of results to return.
Is HighlightedOptionalWhether to highlight the results.
Page NumberOptionalEnter the page number for pagination.
Search QueryOptionalEnter the query to search for results.
Sort ByOptionalSpecify the criteria to sort the results.
Sort DirectionOptionalSpecify the direction to sort the results (e.g., ascending, descending).

Auth

FieldRequiredDescription
Auth TypeOptionalSelect the authentication method for the request. Options: No Auth, OAuth 2.
Auth ResourceOptionalOAuth resource containing credentials.

Input

This activity is built on the REST Client, so the Input tab is the generic HTTP request rather than a Slack-shaped payload.

FieldRequiredData TypeDescription
TargetRequiredObjectThe HTTP request.

Output

The activity returns an httpResponse object.

FieldData TypeDescription
status.codeIntegerNumeric HTTP status code.
status.messageStringShort message associated with the HTTP status.
headersObjectHTTP response headers.
bodyObjectParsed body of the response.
note

The output schema for this activity declares the response body without describing its properties, so no response fields are listed here.