Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #4

Merged
merged 1 commit into from
Aug 19, 2023
Merged

Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 0 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,23 +27,6 @@ and player information in the game Old School RuneScape.

### API Gateway driven

- **osrs-tracker_discord-alert**

When invoking the lambda function with the following body, an message will be sent to the discord webhook specified by
`process.env.WEBHOOK_URL`. A helper function to make this easier can be found in the `@osrs-tracker/aws-alerting`
package.

```ts
{
title?: string;
description?: string;
color?: string; // hexadecimal in string format, ex. '0xff0000' for red.
authorName?: string;
authorUrl?: string; // url to navigate to when author name is clicked.
timestamp?: string; // As ISO string, ex. '2023-08-09T16:26:48.965Z'.
}
```

- **osrs-tracker_item-info**

When sending a `GET /:id` request, this function returns item details from MongoDB.
Expand Down