Skip to content

Commit 117b39e

Browse files
committed
Update eventbridge-webhooks README
1 parent 1767cbf commit 117b39e

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

eventbridge-webhooks/README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Inbound webhooks for EventBridge
22

3-
This pattern creates an inbound webhook from Stripe to Amazon EventBridge. The webhook is a Lambda function URL that verifies the inbound request then forwards it to EventBridge.
3+
These patterns creates an inbound webhook for various 3P (Stripe/GitHub/Twilio) to Amazon EventBridge. The webhook is a Lambda function URL that verifies the inbound request then forwards it to EventBridge.
44

5-
Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/eventbridge-webhook-stripe
5+
Learn more about this pattern at Serverless Land Patterns: https://serverlessland.com/patterns/eventbridge-webhooks
66

77
Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the [AWS Pricing page](https://aws.amazon.com/pricing/) for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.
88

@@ -23,35 +23,36 @@ Important: this application uses various AWS services and there are costs associ
2323
```
2424
cd eventbridge-webhooks
2525
```
26-
3. There are several examples in this directory.
27-
- To run the GitHub example, change to the `2-github` folder
28-
```
29-
cd 2-github
30-
```
31-
1. The GitHub Inbound webhook requires a Secret prior to creating the CloudFormation Stack. [Create Encrypted Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets)
32-
2. Use AWS SAM to build the template.
26+
There are several examples in this directory:
27+
28+
3. For example, to run the GitHub example, change to the `2-github` folder
29+
```
30+
cd 2-github
31+
```
32+
5. The GitHub Inbound webhook requires a Secret prior to creating the CloudFormation Stack. [Create Encrypted Secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets)
33+
6. From the command line, use AWS SAM to build the template.
3334
```
3435
sam build
3536
```
36-
3. From the command line, use AWS SAM to deploy the AWS resources for the pattern as specified in the template.yml file:
37+
7. From the command line, use AWS SAM to deploy the AWS resources for the pattern as specified in the template.yml file:
3738
```
3839
sam deploy --guided
3940
```
40-
2. During the prompts:
41+
8. During the prompts:
4142
* Enter a stack name
4243
* Enter the desired AWS Region
4344
* Enter the secret
4445
* Allow SAM CLI to create IAM roles with the required permissions.
4546
Once you have run `sam deploy --guided` mode once and saved arguments to a configuration file (samconfig.toml), you can use `sam deploy` in future to use these defaults.
4647
47-
3. Note the outputs from the SAM deployment process. These contain the resource names and/or ARNs which are used for testing.
48+
9. Note the outputs from the SAM deployment process. These contain the resource names and/or ARNs which are used for testing.
4849
49-
4. Create the webhook on GitHub. You’ll need the secret you created in step 1 and the Lambda function URL you deployed in step 2 to complete this step. [Set up GitHub Webhook](https://docs.github.com/en/developers/webhooks-and-events/webhooks/creating-webhooks)
50+
10. Create the webhook on GitHub. You’ll need the secret you created in step 1 and the Lambda function URL you deployed in step 2 to complete this step. [Set up GitHub Webhook](https://docs.github.com/en/developers/webhooks-and-events/webhooks/creating-webhooks)
5051
5152
5253
## How it works
5354
54-
GitHub emits events for a variety of actions, for example, when a repository was created or the status of a commit changed. Using Inbound webhooks using Lambda function URLs you can send the payloads to EventBridge for processing. More info on GitHub Webhooks can be found [here](https://docs.github.com/en/developers/webhooks-and-events/webhooks/about-webhooks).
55+
The services such as GitHub emit events for a variety of actions, for example, when a repository was created or the status of a commit changed. Using inbound webhooks using Lambda function URLs you can send the payloads to EventBridge for processing. More info on GitHub Webhooks can be found [here](https://docs.github.com/en/developers/webhooks-and-events/webhooks/about-webhooks).
5556
5657
## Testing
5758
@@ -63,13 +64,13 @@ GitHub emits events for a variety of actions, for example, when a repository was
6364
6465
1. Delete the stack
6566
```bash
66-
aws cloudformation delete-stack --stack-name STACK_NAME
67+
sam delete
6768
```
6869
2. Confirm the stack has been deleted
6970
```bash
7071
aws cloudformation list-stacks --query "StackSummaries[?contains(StackName,'STACK_NAME')].StackStatus"
7172
```
7273
----
73-
Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
74+
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
7475
7576
SPDX-License-Identifier: MIT-0

0 commit comments

Comments
 (0)