Skip to content

Commit a4172b2

Browse files
committed
docs: update docs
1 parent 6a1656f commit a4172b2

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

apps/processing/.env.example

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,7 @@ COINGECKO_API_TYPE=demo
1818
RETRY_MAX_ATTEMPTS=3
1919
RETRY_BASE_DELAY_MS=3000
2020
RETRY_FACTOR=2
21-
RETRY_MAX_DELAY_MS=300000
21+
RETRY_MAX_DELAY_MS=300000
22+
23+
NOTIFIER_PROVIDER=# 'slack' or 'null'
24+
SLACK_WEBHOOK_URL=

packages/shared/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,13 @@ You can import the package in your TypeScript files as follows:
3939
```typescript
4040
import { ILogger, ProcessorEvent, stringify } from "@grants-stack-indexer/shared";
4141
```
42+
43+
### Configuring the Notifier
44+
45+
#### Slack
46+
47+
Visit [Slack API docs](https://api.slack.com/messaging/webhooks) to create a Slack app and get a webhook URL. Follow the instructions for setting up a Slack app and get a webhook URL. Also, you can further customize the bot name, icons and scopes.
48+
49+
#### Null
50+
51+
The null notifier is a no-op notifier that does nothing. It is useful when you want to disable notifications.

0 commit comments

Comments
 (0)