Package com.slack.api.webhook

Class Payload

java.lang.Object
com.slack.api.webhook.Payload
public class Payload extends Object
https://api.slack.com/incoming-webhooks

Implementation of Incoming Webhook Payloads

  • Method Details

    • builder

      public static Payload.PayloadBuilder builder()

    • getThreadTs

      public String getThreadTs()
      You can add the thread_ts parameter to your POST request in order to make your message appear as a reply in a thread.

    • getText

      public String getText()
      The first step is to prepare this message as a key/value pair in JSON. For a simple message, your JSON payload only needs to define a text property, containing the text that will be posted to the channel.

    • getChannel

      @Deprecated public String getChannel()
      Deprecated.
      NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

      Incoming webhooks output to a default channel and can only send messages to a single channel at a time. You can override a custom integration's configured channel by specifying the channel field in your JSON payload.

      Specify a Slack channel by name with "channel": "#other-channel", or send a Slackbot message to a specific user with "channel": "@username".

    • getUsername

      @Deprecated public String getUsername()
      Deprecated.
      NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

      Incoming webhooks originate from a default identity you configured when originally creating your webhook. You can override a custom integration's configured name with the username field in your JSON payload.

    • getIconUrl

      @Deprecated public String getIconUrl()
      Deprecated.
      NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

      You can also override the bot icon either with icon_url or icon_emoji.

    • getIconEmoji

      @Deprecated public String getIconEmoji()
      Deprecated.
      NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

      You can also override the bot icon either with icon_url or icon_emoji.

    • getBlocks

      public List<LayoutBlock> getBlocks()
      An array of layout blocks in the same format as described in the layout block guide.

    • getAttachments

      public List<Attachment> getAttachments()
      An array of legacy secondary attachments. We recommend you use blocks instead.

    • getUnfurlLinks

      public Boolean getUnfurlLinks()
      Pass true to enable unfurling of primarily text-based content.

    • getUnfurlMedia

      public Boolean getUnfurlMedia()
      Pass false to disable unfurling of media content.

    • getMetadata

      public Message.Metadata getMetadata()
      https://api.slack.com/metadata

    • setThreadTs

      public void setThreadTs(String threadTs)
      You can add the thread_ts parameter to your POST request in order to make your message appear as a reply in a thread.

    • setText

      public void setText(String text)
      The first step is to prepare this message as a key/value pair in JSON. For a simple message, your JSON payload only needs to define a text property, containing the text that will be posted to the channel.

    • setChannel

      @Deprecated public void setChannel(String channel)
      Deprecated.
      NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

      Incoming webhooks output to a default channel and can only send messages to a single channel at a time. You can override a custom integration's configured channel by specifying the channel field in your JSON payload.

      Specify a Slack channel by name with "channel": "#other-channel", or send a Slackbot message to a specific user with "channel": "@username".

    • setUsername

      @Deprecated public void setUsername(String username)
      Deprecated.
      NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

      Incoming webhooks originate from a default identity you configured when originally creating your webhook. You can override a custom integration's configured name with the username field in your JSON payload.

    • setIconUrl

      @Deprecated public void setIconUrl(String iconUrl)
      Deprecated.
      NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

      You can also override the bot icon either with icon_url or icon_emoji.

    • setIconEmoji

      @Deprecated public void setIconEmoji(String iconEmoji)
      Deprecated.
      NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

      You can also override the bot icon either with icon_url or icon_emoji.

    • setBlocks

      public void setBlocks(List<LayoutBlock> blocks)
      An array of layout blocks in the same format as described in the layout block guide.

    • setAttachments

      public void setAttachments(List<Attachment> attachments)
      An array of legacy secondary attachments. We recommend you use blocks instead.

    • setUnfurlLinks

      public void setUnfurlLinks(Boolean unfurlLinks)
      Pass true to enable unfurling of primarily text-based content.

    • setUnfurlMedia

      public void setUnfurlMedia(Boolean unfurlMedia)
      Pass false to disable unfurling of media content.

    • setMetadata

      public void setMetadata(Message.Metadata metadata)
      https://api.slack.com/metadata

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object