LogoLogo
  • Introduction
  • What's New?
  • Upgrade Guide
  • Getting Started
    • Requirements
    • Installation
  • Defining Channels
    • Configuration
    • Retrieving Channels
  • Creating and Sending Notifications
    • Defining Notifications
    • Notifiables
    • Sending Notifications
  • Providers
    • DatabaseProvider
    • EmailProvider
    • SlackProvider
      • Slack BlockKit
    • Creating Custom Providers
  • Testing
    • Coming Soon
  • Reference
    • NotificationService
    • BaseNotification
    • SendsNotifications
    • INotifiable
    • BaseProvider
      • DatabaseProvider
        • DatabaseNotificationService
        • HasDatabaseNotifications
        • DatabaseNotificationCursor
        • DatabaseNotification
      • EmailProvider
      • SlackProvider
        • SlackMessage
          • EventMetadata
          • ActionsBlock
          • ContextBlock
          • DividerBlock
          • HeaderBlock
          • ImageBlock
          • SectionBlock
          • ButtonElement
          • ConfirmObject
          • ImageElement
          • TextObject
          • PlainTextOnlyTextObject
  • ForgeBox
  • GitHub
Powered by GitBook
On this page
  • init
  • id
  • getMemento
  1. Reference
  2. BaseProvider
  3. SlackProvider
  4. SlackMessage

HeaderBlock

PreviousDividerBlockNextImageBlock

Last updated 1 year ago

init

Creates an HeaderBlock instance.

Slack Docs:

Name
Type
Required
Default
Description

text

string

true

The text of the header. Maximum length of 150 characters.

callback

function

false

null

An optional callback to configure the new HeaderBlock.

Return: The HeaderBlock instance.

id

Sets a custom identifier for the HeaderBlock instance.

Name
Type
Required
Default
Description

id

string

true

The custom identifier for the HeaderBlock instance.

Return: The HeaderBlock instance.

getMemento

Converts the HeaderBlock instance to a serializable format.

Name
Type
Required
Default
Description

No arguments

Return: (struct) A struct representing this HeaderBlock instance.

{
    "type": "header",
    "text": {
        "type": "plain_text",
        "text": "My Header"
    },
    "block_id": "optional"
}
https://api.slack.com/reference/block-kit/blocks#header