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

Webhook Lambda Handler Documentation #649

Merged
merged 9 commits into from
Jan 17, 2024

Conversation

benbpyle
Copy link
Contributor

Added in the README and images to support

Added in the README and images to support
@allenheltondev
Copy link
Collaborator

Once this PR is merged, please move this file under the integrations folder at the root of the Topics page.

Also, we need the frontmatter I sent you in DM added to the documentation as well. I know you know that but putting it here for reference.

@@ -0,0 +1,116 @@
## Deploying an AWS Lambda Webhook Handler
Copy link
Collaborator

Choose a reason for hiding this comment

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

This should be an h1, meaning only one # sign. Let's also rename this to
"Configure Momento Topics to publish events to Amazon EventBridge"

}
```

### Event Structure
Copy link
Collaborator

Choose a reason for hiding this comment

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

Our style guide only capitalizes the first word in a heading, can you please go through and update capitalization.
The exception to the rule is proper nouns/products and code/properties like you have below.


The message detail will contain the actual payload as supplied from the webhook. By not removing elements from the message, maximum detail is provided to all consuming applications. For reference, the Momento webhook payload fields are [described here.](https://docs.momentohq.com/topics/webhooks/overview#example-event)

## Notes and Wrapping Up
Copy link
Collaborator

Choose a reason for hiding this comment

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

To make it feel less bloggy/story, Maybe change this to "Considerations" and remove the storytelling part of the first paragraph in here.

1. Moved files under top-level integrations directory
2. Added in the intro content that matters for the docs web structure
3. Modified initial heading content per PR request
4. Changed top header to by H1 from H2
5. Removed capitalization from words that aren't proper in title headings and aren't the first word in the heading
6. Changed "Notes" to "Considerations" and rewrote the first paragraph in that section
@benbpyle
Copy link
Contributor Author

@allenheltondev modified the source to match the PR notes. Description of changes is in the commit message description

@allenheltondev allenheltondev merged commit ecf231b into momentohq:main Jan 17, 2024
4 checks passed
@benbpyle benbpyle deleted the lambda-webhook-handler-doc branch January 20, 2024 14:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants