https://github.com/devatherock/slack-webhook-facade

A Slack webhook facade to post messages to other chat clients like Zulip
https://github.com/devatherock/slack-webhook-facade

facade slack slack-webhook-facade webhook zulip

Last synced: 8 days ago
JSON representation

A Slack webhook facade to post messages to other chat clients like Zulip

• Host: GitHub
• URL: https://github.com/devatherock/slack-webhook-facade
• Owner: devatherock
• License: mit
• Created: 2020-06-15T03:47:59.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-09T12:16:00.000Z (over 1 year ago)
• Last Synced: 2024-10-31T10:51:30.704Z (about 2 months ago)
• Topics: facade, slack, slack-webhook-facade, webhook, zulip
• Language: Go
• Homepage:
• Size: 41 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CircleCI](https://circleci.com/gh/devatherock/slack-webhook-facade.svg?style=svg)](https://circleci.com/gh/devatherock/slack-webhook-facade)

[![Version](https://img.shields.io/docker/v/devatherock/slack-webhook-facade?sort=semver)](https://hub.docker.com/r/devatherock/slack-webhook-facade/)

[![Coverage Status](https://coveralls.io/repos/github/devatherock/slack-webhook-facade/badge.svg?branch=master)](https://coveralls.io/github/devatherock/slack-webhook-facade?branch=master)

[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=slack-webhook-facade&metric=alert_status)](https://sonarcloud.io/component_measures?id=slack-webhook-facade&metric=alert_status&view=list)

[![Docker Pulls](https://img.shields.io/docker/pulls/devatherock/slack-webhook-facade.svg)](https://hub.docker.com/r/devatherock/slack-webhook-facade/)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=slack-webhook-facade&metric=ncloc)](https://sonarcloud.io/component_measures?id=slack-webhook-facade&metric=ncloc)

[![Docker Image Size](https://img.shields.io/docker/image-size/devatherock/slack-webhook-facade.svg?sort=date)](https://hub.docker.com/r/devatherock/slack-webhook-facade/)

# slack-webhook-facade

A Slack webhook facade to post messages to other chat clients like [Zulip](https://zulipchat.com/)

## Usage

### Zulip

To post a slack webhook message to zulip, use the slack webhook URL in the below format:

```

{slackWebhookFacadeHost}/zulip/{base64(username:zulipApiKey)}?server={zulipHost}

```

#### Sample URL

```

https://slack-webhook-facade.onrender.com/zulip/Y2ktYm90QHp1bGlwY2hhdC5jb206eHl6?server=https://devatherock-chat.zulipchat.com

```

#### Sample slack payload to post to the facade

```json

{

  "text": "https://circleci.com/gh/devatherock/git-sync/66 by devatherock",

  "channel": "general",

  "attachments": [

    {

      "title": "Build completed",

      "text": "https://circleci.com/gh/devatherock/git-sync/66 by devatherock",

      "color": "#764FA5"

    }

  ]

}

```

#### Parameters

**Path parameters**

- **slackWebhookFacadeHost** - Host name of your `slack-webhook-facade` instance

- **base64(username:zulipApiKey)** - Base64 encoded value of the Zulip bot integration's username and API key, joined

together by a colon. Will be used as the `Basic` authorization header in the call to Zulip API. If the username is

`[email protected]` and the API key is `xyz`, the path variable will be what is in the sample URL

**Query parameters**

- **zulipHost** - Host name of your Zulip instance

**Payload parameters**

- **channel** - The Zulip `stream` to post the message to

- **title** - The `topic` name in Zulip