You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: eventbridge-webhooks/README.md
+17-16Lines changed: 17 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Inbound webhooks for EventBridge
2
2
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.
4
4
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
6
6
7
7
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.
8
8
@@ -23,35 +23,36 @@ Important: this application uses various AWS services and there are costs associ
23
23
```
24
24
cd eventbridge-webhooks
25
25
```
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.
33
34
```
34
35
sam build
35
36
```
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:
37
38
```
38
39
sam deploy --guided
39
40
```
40
-
2. During the prompts:
41
+
8. During the prompts:
41
42
* Enter a stack name
42
43
* Enter the desired AWS Region
43
44
* Enter the secret
44
45
* Allow SAM CLI to create IAM roles with the required permissions.
45
46
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.
46
47
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.
48
49
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)
50
51
51
52
52
53
## How it works
53
54
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).
55
56
56
57
## Testing
57
58
@@ -63,13 +64,13 @@ GitHub emits events for a variety of actions, for example, when a repository was
0 commit comments