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.

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

API Builder use case 1: Send a notification to a specific Slack/Discorfd/Zapier/URL every time a post is published #16425

Open
JennieOcken opened this issue Feb 4, 2022 · 1 comment
Assignees
Labels
changelog: spotlight Items that will get their own changelog posts and spotlighted on hold

Comments

@JennieOcken
Copy link

JennieOcken commented Feb 4, 2022

As a Forem admin I want to create an API request that will allow me to send a notification every time a post is published.

I will be using this to push notifications about new posts to my Discord or Slack. I may also use it with intermediary tools like Zapier or IFTTT to update other systems.

The payload of this POST request would include title and URL and could be filterable by tag.

However, we are using this as a use case for our broader goal to generalize an API builder. This API builder will only be used with outgoing API calls. This would allow an admin to define the event, the payload (within some defined options), URL, headers, nickname, description, etc. This interface could start as a simple YAML file for the payload to maximize the ability to copypasta standard cases. We would need to think through if all cases require admin authentication.

Discovery/Discussion document

@JennieOcken JennieOcken added the changelog: spotlight Items that will get their own changelog posts and spotlighted label Feb 9, 2022
@joshpuetz
Copy link
Contributor

Point of clarification: this kind of 'pushing' data from a system is known as a webhook not an API.

@joshpuetz joshpuetz self-assigned this Apr 21, 2022
@forem forem deleted a comment from github-actions bot Apr 28, 2022
@joshpuetz joshpuetz added the blocked blocked by internal or external issues label May 2, 2022
@joshpuetz joshpuetz added on hold and removed blocked blocked by internal or external issues labels Jul 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog: spotlight Items that will get their own changelog posts and spotlighted on hold
Projects
None yet
Development

No branches or pull requests

2 participants