Skip to content

Commit

Permalink
Update documentation for webhooks to show new method option
Browse files Browse the repository at this point in the history
  • Loading branch information
SludgeGirl committed Aug 24, 2023
1 parent d0021fd commit 429a82b
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/webhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ constructs:
authorizer:
handler: myAuthorizer.main
path: /my-webhook-endpoint
method: POST

plugins:
- serverless-lift
Expand Down Expand Up @@ -162,6 +163,23 @@ constructs:

Always favor dynamic path selector to ensure the minimum amount of compute is executed downstream. The list of available dynamic selector is available in [API Gateway documentation](https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-aws-services.html#http-api-develop-integrations-aws-services-parameter-mapping).

### Method

_Optional_
Defaults to `POST`

This is the HTTP method the webhook will accept. It can be any of the following:
- `POST`
- `PUT`
- `PATCH`

```yaml
constructs:
stripe:
# ...
method: POST
```

## Extensions

You can specify an `extensions` property on the webhook construct to extend the underlying CloudFormation resources. In the exemple below, the EventBridge Bus CloudFormation resource generated by the `stripe` webhook construct will be extended with the new `Name: StripeBus` CloudFormation property.
Expand Down

0 comments on commit 429a82b

Please sign in to comment.