adam
/
slack-webhook-orb
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
CircleCI Orb for sending Slack messages via webhooks.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
16 Commits
1 Branch
5 Tags
89 KiB
main
0.0.1
0.0.2
0.0.3
0.0.4
1.0.0
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'main'
${ noResults }
Go to file
Adam Millerchip 2f3f9af3ba Prepare 1.0.0 release. 2 years ago
CHANGELOG.md Prepare 1.0.0 release. 2 years ago
LICENSE Add initial orb config. 2 years ago
README.md Fix typo. 2 years ago
slack-webhook-orb.yml Prepare 1.0.0 release. 2 years ago

README.md

Slack Webhook CircleCI Orb CircleCI Orb Version

Setup

  1. Create a webhook.
  2. Generate a JSON payload.
  3. Place the webhook in a CircleCI environment variable (SLACK_WEBHOOK by default, but customizable).
  4. Call the orb: 
    slack-webhook/send-message:
  json-payload: |
    {
      "blocks": [
        {
          "type": "section",
          "text": {
            "type": "mrkdwn",
            "text": "Hello from <https://github.com/adamu|@adamu>'s `slack-webhook` CircleCi orb! 👋"
          }
        }
      ]
    }

Usage

The json-payload argument must always be provided.

There are three ways to provide the webhook URL:

  1. Via the SLACK_WEBHOOK environment variable.
  2. Via a custom environment variable. Provide the name with the webhook-url-env-var parameter.
  3. Directly to the send-message command with the webhook-url parameter.

See the full examples on the orb's CircleCI Orb Repository listing.

Changelog

See the CHANGELOG.