Skip to content

Add docs for global trigger events, app mentions#132

Draft
slowcooked99 wants to merge 6 commits into
mainfrom
DX-11040-global-trigger-app-mention-docs
Draft

Add docs for global trigger events, app mentions#132
slowcooked99 wants to merge 6 commits into
mainfrom
DX-11040-global-trigger-app-mention-docs

Conversation

@slowcooked99

Copy link
Copy Markdown

💸 TL;DR

Drafts documentation about global trigger events, specifically for app mentions.

📜 Details

Internal issue: DX-11040

🧪 Testing Steps / Validation

yarn start docs

✅ Checks

  • CI tests (if present) are passing
  • Adheres to code style for repo
  • Contributor License Agreement (CLA) completed if not a Reddit employee

Comment on lines +6 to +10
Global triggers let your app respond to Reddit events even when those events happen outside the subreddit where your app is installed.

Currently, Devvit supports one global trigger:

- `onMentionInCommentCreate`

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think we should have an example here? onMentionInCommentCreate is carrying a lot of weight (which is a good sign for the api name), but not immediately obvious


# Global Triggers

Global triggers let your app respond to Reddit events even when those events happen outside the subreddit where your app is installed.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add something about our allowlist after the first sentence here:

"This feature is for approved apps only. Developers can request access to app mention triggers here"

Also should we use "App Mentions Triggers" rather "Global Triggers" @stacy-qqq?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I think we should use "App Mentions Triggers".

Question for you @pl00h - how do apps get approved for this? Is it like a gated beta? Do devs need to apply?

Updated terminology from 'Global Triggers' to 'App Mention Triggers' throughout the document. Adjusted descriptions and examples to reflect the new terminology.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants