API Intro

The Birthday API allows for 2 endpoints currently.

• Add a Birthday
• Get birthdays

Instructions to add to firebot

Instructions to add to Discord

Add a Birthday endpoint

Intro

Adds a birthday to the nosql database. Requires both listed parameters

Example request

Endpoint

":8081/add_birthday"

Request type

"GET"

Parameters (in red required)

date

• Type: String
• Enter the date like: "01-01"
• Ex: :8081/add_birthday?date=01-01

name

• Type: String
• Enter person's name (streamer name preferred
• Ex: :8081/add_birthday?name=01-01

Example:

:8081/add_birthday?date=01-01&name=streamer

Response types

200: Successful

Return String:

{name} added to friendo's birthdays <3

200: Failed

Return String:

Please use like: !addbday "MM-DD" "name"

Top of Page

Get Birthday endpoint

Intro

Returns all birthdays for given date

Example request

Endpoint

":8081/get_birthdays"

Request type

"GET"

Parameters (in red required)

date

• Type: String
• Enter date like: 01-01
• Ex: :8081/get_birthdays?date=01-01

Example:

:8081/get_birthdays?date=01-01

Response types

200: Successful

Return String:

The following friendos have birthdays on {date}

200: Failed

Return String:

Please use like: !getbday \"01-01\"

Top of Page

Add Get Birthday Command to Firebot

Add Add Birthday Command to Firebot

Top of Page

Discord Instructions Under Construction

Top of Page