SlackWebhook
Last updated
Last updated
typeNamespace
SlackWebhook.Enums
Summary
Action type
constantsSummary
Turns the button red and indicates it some kind of destructive action
constantsSummary
Turns the button green and indicates the best forward action to take
typeNamespace
SlackWebhook.Core
Summary
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
typeNamespace
SlackWebhook.Core
Summary
Handles escaping characters which the Slack webhook expects to be HTML encoded.
typeNamespace
SlackWebhook.Core
Summary
Cloneable type
Generic Types
Name
Description
T
Type of clone
methodSummary
Creates new clone of this instance
Returns
Cloned instance
Parameters
This method has no parameters.
typeNamespace
SlackWebhook.Enums
Summary
Icon type
constantsSummary
Icon is a slack emoji name, e.g.
constantsSummary
Icon is a image URL
typeNamespace
SlackWebhook
Summary
methodSummary
With author name, and optional link url and icon url
Parameters
Name
Type
Description
name
Author name (required)
linkUrl
Author link url (optional)
iconUrl
Author icon url (optional)
Remarks
The author parameters will display a small section at the top of a message attachment.
methodSummary
With hex-based color
Parameters
Name
Type
Description
hexColor
Hex color or one of named colors (good, warning, danger)
Remarks
Like traffic signals, color-coding messages can quickly communicate intent and help separate them from the flow of other messages in the timeline.
An optional value that can either be one of good, warning, danger, or any hex color code(eg. #439FE0). This value is used to color the border along the left side of the message attachment.
methodSummary
Parameters
Name
Type
Description
color
Color instance to set color from
methodSummary
With required plain-text summary of the attachment
Returns
Parameters
Name
Type
Description
fallback
Remarks
A plain-text summary of the attachment. This text will be used in clients that don't show formatted text (eg. IRC, mobile notifications) and should not contain any markup.
methodSummary
With attachment field shown as a table inside the message attachment
Parameters
Name
Type
Description
title
Title of field
Remarks
If enableFormattingis enabled, you can use Slack message formatting in valueand it will automatically be encoded according to slack encoding rules.
methodSummary
With footer text and optional footer icon
Returns
Parameters
Name
Type
Description
text
iconUrl
Remarks
Add some brief text to help contextualize and identify an attachment. Limited to 300 characters, and may be truncated further when displayed to users in environments with limited screen real estate.
To render a small icon beside your footer text, provide a publicly accessible URL string in the footer_icon field. You must also provide a footer for the field to be recognized.
We'll render what you provide at 16px by 16px. It's best to use an image that is similarly sized.
methodSummary
With image url
Parameters
Name
Type
Description
url
Image url
Remarks
A valid URL to an image file that will be displayed inside a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP.
Large images will be resized to a maximum width of 400px or a maximum height of 500px, while still maintaining the original aspect ratio.
methodSummary
With link on attachment title
Parameters
Name
Type
Description
url
Remarks
Link of title (optional)
methodSummary
With link button action, shown at the bottom of the attachment
Parameters
Name
Type
Description
text
Test shown on link button
url
URL opened if link button is pressed
style
Optional style
Remarks
An attachment may contain multiple actions
methodSummary
With optional pre-text
Parameters
Name
Type
Description
text
Pre-text
enableFormatting
Whether or not to enable formatting for text
Remarks
This is optional text that appears above the message attachment block.
methodSummary
With optional text
Parameters
Name
Type
Description
text
Text
enableFormatting
Whether or not to enable formatting for text
Remarks
This is the main text in a message attachment, and can contain standard message markup. The content will automatically collapse if it contains 700+ characters or 5+ linebreaks, and will display a "Show more..." link to expand the content. Links posted in the text field will not unfurl.
If enableFormattingis enabled, you can use Slack message formatting in textand it will automatically be encoded according to slack encoding rules.
methodSummary
With thumbnail url
Parameters
Name
Type
Description
url
Thumbnail url
Remarks
A valid URL to an image file that will be displayed as a thumbnail on the right side of a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP.
The thumbnail's longest dimension will be scaled down to 75px while maintaining the aspect ratio of the image. The filesize of the image must also be less than 500 KB.
For best results, please use images that are already 75px by 75px.
methodSummary
With timestamp based on timestamp
Parameters
Name
Type
Description
timestamp
DateTimeOffset to set timestamp from
Remarks
Does your attachment relate to something happening at a specific time?
By providing the ts field with an integer value in "epoch time", the attachment will display an additional timestamp value as part of the attachment's footer.
Use ts when referencing articles or happenings.Your message will have its own timestamp when published.
Example: Providing 123456789 would result in a rendered timestamp of Nov 29th, 1973.
methodSummary
With epoc timestamp
Parameters
Name
Type
Description
epochTime
Epoch timestamp
Remarks
Does your attachment relate to something happening at a specific time?
By providing the ts field with an integer value in "epoch time", the attachment will display an additional timestamp value as part of the attachment's footer.
Use ts when referencing articles or happenings.Your message will have its own timestamp when published.
Example: Providing 123456789 would result in a rendered timestamp of Nov 29th, 1973.
methodSummary
With required title
Parameters
Name
Type
Description
title
Title
Remarks
typeNamespace
SlackWebhook
Summary
Slack client
methodSummary
Parameters
Name
Type
Description
configureBuilder
Configure message to send using this builder
Exceptions
Name
Description
Thrown if validation of the message fails, such as if a required field is missing.
methodSummary
Parameters
Name
Type
Description
message
Slack message to send
Exceptions
Name
Description
Thrown if validation of the message fails, such as if a required field is missing.
typeNamespace
SlackWebhook
Summary
methodSummary
Returns
New message
Parameters
This method has no parameters.
Exceptions
Name
Description
Thrown if validation of the message fails, such as if a required field is missing.
methodSummary
With attachment build with provided attachment builder
Parameters
Name
Type
Description
configureAttachment
Attachment builder
Remarks
methodSummary
With channel
Parameters
Name
Type
Description
channel
The channel.
Remarks
methodSummary
With icon (url or emoji)
Parameters
Name
Type
Description
iconType
Type of icon
urlOrEmoji
URL or emoji name (depending on iconType)
Remarks
methodSummary
With required message text
Parameters
Name
Type
Description
text
Message text
enableFormatting
Whether or not to enable formatting for text
Remarks
If enableFormattingis enabled, you can use Slack message formatting in textand it will automatically be encoded according to slack encoding rules.
methodSummary
With username
Parameters
Name
Type
Description
username
Username
Remarks
typeNamespace
SlackWebhook.Core
Summary
Object can be validated
methodSummary
Validates the current state of the object (including any nested validateable members)
Returns
True if the object is valid, false otherwise
Parameters
Name
Type
Description
validationErrors
Validation errors (if any found)
Remarks
Will find all (if any) validation errors and populate validationErrorswith each
typeNamespace
SlackWebhook.Messages
Summary
constantsSummary
constantsSummary
constantsSummary
propertySummary
Actions shown at the bottom of the message (optional)
propertySummary
Author icon URL (optional)
Remarks
propertySummary
Author link (optional)
Remarks
propertySummary
Author name (optional)
Remarks
The author parameters will display a small section at the top of a message attachment
propertySummary
Gets or sets the color.
Remarks
Like traffic signals, color-coding messages can quickly communicate intent and help separate them from the flow of other messages in the timeline.
An optional value that can either be one of good, warning, danger, or any hex color code(eg. #439FE0). This value is used to color the border along the left side of the message attachment.
propertySummary
propertySummary
Required plain-text summary of the attachment
Remarks
A plain-text summary of the attachment. This text will be used in clients that don't show formatted text (eg. IRC, mobile notifications) and should not contain any markup.
propertySummary
Fields shown as a table inside the message attachment (optional)
propertySummary
Footer text shown at the bottom of attachment (optional)
Remarks
Add some brief text to help contextualize and identify an attachment. Limited to 300 characters, and may be truncated further when displayed to users in environments with limited screen real estate.
propertySummary
Icon shown left of footer text (optional)
Remarks
To render a small icon beside your footer text, provide a publicly accessible URL string in the footer_icon field. You must also provide a footer for the field to be recognized.
We'll render what you provide at 16px by 16px. It's best to use an image that is similarly sized.
propertySummary
Image url (optional)
Remarks
A valid URL to an image file that will be displayed inside a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP.
Large images will be resized to a maximum width of 400px or a maximum height of 500px, while still maintaining the original aspect ratio.
propertySummary
Optional text that appears above the attachment block
Remarks
This is optional text that appears above the message attachment block.
propertySummary
Optional text that appears within the attachment
Remarks
This is the main text in a message attachment, and can contain standard message markup. The content will automatically collapse if it contains 700+ characters or 5+ linebreaks, and will display a "Show more..." link to expand the content. Links posted in the text field will not unfurl.
propertySummary
Thumbnail url (optional)
Remarks
A valid URL to an image file that will be displayed as a thumbnail on the right side of a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP.
The thumbnail's longest dimension will be scaled down to 75px while maintaining the aspect ratio of the image. The filesize of the image must also be less than 500 KB.
For best results, please use images that are already 75px by 75px.
propertySummary
Timestamp (epoch time) shown below attachment (optional)
Remarks
Does your attachment relate to something happening at a specific time?
By providing the ts field with an integer value in "epoch time", the attachment will display an additional timestamp value as part of the attachment's footer.
Use ts when referencing articles or happenings.Your message will have its own timestamp when published.
Example: Providing 123456789 would result in a rendered timestamp of Nov 29th, 1973.
propertySummary
Title of attachment (required)
Remarks
propertySummary
Link of title (optional)
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Parameters
Name
Type
Description
color
Color to set color hex from
methodSummary
Parameters
Name
Type
Description
timestamp
Timestamp to set epohc time from
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
typeNamespace
SlackWebhook.Messages
Summary
constructorSummary
Initialize attachment action
Parameters
Name
Type
Description
type
Type of action
propertySummary
Text displayed for the action
Remarks
How this is presented depends on the type of action
propertySummary
Type of action
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
typeNamespace
SlackWebhook
methodSummary
Parameters
Name
Type
Description
formattingType
Formatting type
enable
Whether to enable (add) or disable (remove)
typeNamespace
SlackWebhook.Messages
Summary
propertySummary
Whether field can be shown side-by-side with other fields (optional)
propertySummary
Title of field
Remarks
Shown as a bold heading above the value text. It cannot contain markup and will be escaped for you.
propertySummary
Value of field (may contain formatting if enabled)
Remarks
The text value of the field. It may contain standard message markup and must be escaped as normal. May be multi-line.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
typeNamespace
SlackWebhook.Messages
Summary
constructorSummary
Create new empty link button action
Parameters
This constructor has no parameters.
propertySummary
Optional style
propertySummary
URL to open if link button is clicked
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
typeNamespace
SlackWebhook
Summary
Inherit from parent.
constructorSummary
Inherit from parent.
Parameters
This constructor has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
typeNamespace
SlackWebhook.Messages
Summary
Basis for a Slack message which can be sent to the webhook URL
propertySummary
Attachments to show below message (optional)
propertySummary
Channel the message is posted into (optional)
propertySummary
Whether or not to enable formatting for this message
Remarks
Default true
propertySummary
Icon emoji name () (optional)
Remarks
propertySummary
Icon URL to show before username (optional)
Remarks
propertySummary
Remarks
You can use the regular Slack formatting
and also include links
propertySummary
Username shown (optional)
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
typeNamespace
SlackWebhook
Summary
Inherit from parent.
constructorSummary
Create new slack message builder
Parameters
This constructor has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
typeNamespace
SlackWebhook.Exceptions
Summary
Slack message validation exception
constructorSummary
Create new validation exception
Parameters
Name
Type
Description
message
Exception message
validationErrors
Validation errors
propertySummary
Validations errors
typeNamespace
SlackWebhook.Exceptions
Summary
Validation error details
constructorSummary
Create new validation error
Parameters
Name
Type
Description
typeName
Type where validation error occurred
propertyName
Property which failed validation
error
Validation error
propertySummary
Validation error
propertySummary
Property which failed validation
propertySummary
Type where validation error occurred
methodSummary
Inherit from parent.
Parameters
This method has no parameters.
json converter
See for more.
Slack attachment builder used to configure an attachment to be added to a
A valid URL that will hyperlink the text mentioned above. Will only work if is present.
A valid URL that displays a small 16x16px image to the left of the text. Will only work if is present.
With color from instance
Shown as a bold heading above the value text. It cannot contain markup and will be escaped for you. | | value | | Value of field (may contain formatting if enabled)
The text value of the field. It may contain standard message markup and must be escaped as normal. May be multi-line. | | isShort | | Whether field can be shown side-by-side with other fields (optional) | | enableFormatting | | Whether or not to enable formatting for value |
The title is displayed as larger, bold text near the top of a message attachment. By passing a valid URL in the parameter (optional), the title text will be
Send new by configuring the provided
Uses to perform validation. |
Send the provided
Uses to perform validation. |
Slack message builder that produces instances based on the builder's current configuration.
Build based on current state of the builder
Uses to perform validation. |
Adds a new to built using provided
Sets the property
Sets the or based on iconTypewith the provided value urlOrEmoji
Sets the and properties.
Sets the property
Optional attachment to a .
See for more details
Used to enable formatting of the value fields
Used to enable formatting of the field
Used to enable formatting of the field
A valid URL that displays a small 16x16px image to the left of the text. Will only work if is present.
A valid URL that will hyperlink the text mentioned above. Will only work if is present.
Enable formatting for various fields of the attachment, use , and to contorl which fields have formatting enabled.
The title is displayed as larger, bold text near the top of a message attachment. By passing a valid URL in the parameter (optional), the title text will be hyperlinked.
Set color hex code from
Set epoch value based on provided date time
Optional action to se .
Enables or disables formatting by adding/removing formattingTypefrom
Optional attachment field added to
Button action which will open a , if clicked
Either provide this OR , but not both
Either provide this OR , but not both
Message text which may contain formatting (unless is deactivated) and can span multiple lines.
Checks the current state using and throws a with all validations errors, if any are found.