https://github.com/actuallyconnor/heyburrito
A replica of Hey Taco that you can setup yourself
https://github.com/actuallyconnor/heyburrito
Last synced: about 1 year ago
JSON representation
A replica of Hey Taco that you can setup yourself
- Host: GitHub
- URL: https://github.com/actuallyconnor/heyburrito
- Owner: ActuallyConnor
- Created: 2021-01-16T02:12:42.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-28T21:26:10.000Z (about 5 years ago)
- Last Synced: 2025-02-05T09:17:34.381Z (over 1 year ago)
- Language: PHP
- Size: 323 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hey Burrito
### The open-source HeyTaco Slack Bot replacement
## Branding colours
- Primary: #F8D233
- Secondary: #1F3FB2
## Setup
### Slack Events API Challenge
Read this documentation [Events API Request URLs](https://api.slack.com/apis/connections/events-api#url_verification)
- You must have an active SSL certificate on your URL endpoint
- The URL verification only needs to be done when setting up or changing the URL endpoint
The way the JSON payload from Slack looks like this:
```json
{
"type": "url_verification",
"token": "hwLi3kEqs0cVt5nkMwHheL9f",
"challenge": "j26kOzF3Xk1mrwPqijjoMo96Q86iLgESYzOdAhTMUWaaz3iu7Lok"
}
```
_Slack may trip you up by showing you what their payload looks like if you fail too many times. The payload data that
they show you is wrong. The payload data that they show you has the data in an object called body. Luckily the function
I have created accounts for this in case Slack ever does decide to wrap the data in an object called body._
To perform the URL verfication follow these steps:
1. In `routes/api.php` change the line for the `/burrito` endpoint to have it use the `slackChallenge()` method instead
of the `giveBurrito()` method.
i.e. It should look like this `Route::post('/burrito', [BurritoController::class, 'slackChallenge']);`
2. In the Slack Bot Event Subscriptions page enter the url endpoint you where that method will now be hit.
i.e. `https://{yourapiurl}/api/burrito`
1. If your verification fails please reread the documentation and run the tests to see if
the function is operating correctly.
3. Subscribe to the following bot events: `app_mention` and `message.channels`
4. Click _'Save Changes'_
5. Revert back your `routes/api.php` file.
## Events
### Core Event Data
```json
{
"token": "ZZZZZZWSxiZZZ2yIvs3peJ",
"team_id": "T061EG9R6",
"api_app_id": "A0MDYCDME",
"event": {
...
},
"type": "event_callback",
"event_id": "Ev0MDYHUEL",
"event_time": 1515449483000108,
"authed_users": [
"U0LAN0Z89"
]
}
```
### Message Event
Requires `channel.history` permission
#### Sample data
```json
{
...,
"event": {
"type": "message",
"channel": "C2147483705",
"user": "U2147483697",
"text": "Hello world",
"ts": "1355517523.000005"
},
...
}
```
### App mention