[![cloudcomponents Logo](https://raw.githubusercontent.com/cloudcomponents/cdk-constructs/master/logo.png)](https://github.com/cloudcomponents/cdk-constructs)
# @cloudcomponents/cdk-stripe-webhook
[![Build Status](https://github.com/cloudcomponents/cdk-constructs/workflows/Build/badge.svg)](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)
[![cdkdx](https://img.shields.io/badge/buildtool-cdkdx-blue.svg)](https://github.com/hupe1980/cdkdx)
[![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/@cloudcomponents/cdk-stripe-webhook)
[![python](https://img.shields.io/badge/jsii-python-blueviolet.svg)](https://pypi.org/project/cloudcomponents.cdk-stripe-webhook/)
> Create, update and delete stripe webhooks with your app deployment
## Install
TypeScript/JavaScript:
```bash
npm i @cloudcomponents/cdk-stripe-webhook
```
Python:
```bash
pip install cloudcomponents.cdk-stripe-webhook
```
## How to use
### EventBus Producer
```python
import { SecretKey, SecretKeyStore } from '@cloudcomponents/cdk-secret-key';
import { StripeWebhook, StripeEventBusProducer } from '@cloudcomponents/cdk-stripe-webhook';
import { Stack, StackProps, aws_ssm } from 'aws-cdk-lib';
import { Construct } from 'constructs';
export class StripeWebhookEventBusStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
if (typeof process.env.SECRET_KEY === 'undefined') {
throw new Error('environment variable SECRET_KEY undefined');
}
const secretKey = SecretKey.fromPlainText(process.env.SECRET_KEY);
const endpointSecretParameter = aws_ssm.StringParameter.fromSecureStringParameterAttributes(this, 'Param', {
parameterName: 'stripe',
version: 1,
});
const producer = new StripeEventBusProducer(this, 'Producer', {
secretKey,
endpointSecret: SecretKey.fromSSMParameter(endpointSecretParameter),
});
const events = ['charge.failed', 'charge.succeeded'];
const endpointSecretStore = SecretKeyStore.fromSSMParameter(endpointSecretParameter);
new StripeWebhook(this, 'StripeWebhook', {
secretKey,
url: producer.url,
events,
logLevel: 'debug',
endpointSecretStore,
});
}
}
```
### Custom Handler
```python
import { SecretKey } from '@cloudcomponents/cdk-secret-key';
import { StripeWebhook } from '@cloudcomponents/cdk-stripe-webhook';
import { Stack, StackProps, aws_apigateway } from 'aws-cdk-lib';
import { Construct } from 'constructs';
export class StripeWebhookStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
const api = new aws_apigateway.RestApi(this, 'Endpoint');
api.root.addMethod('POST');
if (typeof process.env.SECRET_KEY === 'undefined') {
throw new Error('environment variable SECRET_KEY undefined');
}
const secretKey = SecretKey.fromPlainText(process.env.SECRET_KEY);
const events = ['charge.failed', 'charge.succeeded'];
new StripeWebhook(this, 'StripeWebhook', {
secretKey,
url: api.url,
events,
logLevel: 'debug',
});
}
}
```
## API Reference
See [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-stripe-webhook/API.md).
## Example
See more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).
## License
[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-stripe-webhook/LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/cloudcomponents/cdk-constructs",
"name": "cloudcomponents.cdk-stripe-webhook",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.8",
"maintainer_email": null,
"keywords": null,
"author": "hupe1980",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/01/8d/9744e394dcef86f02a2620160bc60c4ebabb054b52311c40fa39b720896a/cloudcomponents.cdk-stripe-webhook-2.3.0.tar.gz",
"platform": null,
"description": "[![cloudcomponents Logo](https://raw.githubusercontent.com/cloudcomponents/cdk-constructs/master/logo.png)](https://github.com/cloudcomponents/cdk-constructs)\n\n# @cloudcomponents/cdk-stripe-webhook\n\n[![Build Status](https://github.com/cloudcomponents/cdk-constructs/workflows/Build/badge.svg)](https://github.com/cloudcomponents/cdk-constructs/actions?query=workflow=Build)\n[![cdkdx](https://img.shields.io/badge/buildtool-cdkdx-blue.svg)](https://github.com/hupe1980/cdkdx)\n[![typescript](https://img.shields.io/badge/jsii-typescript-blueviolet.svg)](https://www.npmjs.com/package/@cloudcomponents/cdk-stripe-webhook)\n[![python](https://img.shields.io/badge/jsii-python-blueviolet.svg)](https://pypi.org/project/cloudcomponents.cdk-stripe-webhook/)\n\n> Create, update and delete stripe webhooks with your app deployment\n\n## Install\n\nTypeScript/JavaScript:\n\n```bash\nnpm i @cloudcomponents/cdk-stripe-webhook\n```\n\nPython:\n\n```bash\npip install cloudcomponents.cdk-stripe-webhook\n```\n\n## How to use\n\n### EventBus Producer\n\n```python\nimport { SecretKey, SecretKeyStore } from '@cloudcomponents/cdk-secret-key';\nimport { StripeWebhook, StripeEventBusProducer } from '@cloudcomponents/cdk-stripe-webhook';\nimport { Stack, StackProps, aws_ssm } from 'aws-cdk-lib';\nimport { Construct } from 'constructs';\n\nexport class StripeWebhookEventBusStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n\n if (typeof process.env.SECRET_KEY === 'undefined') {\n throw new Error('environment variable SECRET_KEY undefined');\n }\n const secretKey = SecretKey.fromPlainText(process.env.SECRET_KEY);\n\n const endpointSecretParameter = aws_ssm.StringParameter.fromSecureStringParameterAttributes(this, 'Param', {\n parameterName: 'stripe',\n version: 1,\n });\n\n const producer = new StripeEventBusProducer(this, 'Producer', {\n secretKey,\n endpointSecret: SecretKey.fromSSMParameter(endpointSecretParameter),\n });\n\n const events = ['charge.failed', 'charge.succeeded'];\n\n const endpointSecretStore = SecretKeyStore.fromSSMParameter(endpointSecretParameter);\n\n new StripeWebhook(this, 'StripeWebhook', {\n secretKey,\n url: producer.url,\n events,\n logLevel: 'debug',\n endpointSecretStore,\n });\n }\n}\n```\n\n### Custom Handler\n\n```python\nimport { SecretKey } from '@cloudcomponents/cdk-secret-key';\nimport { StripeWebhook } from '@cloudcomponents/cdk-stripe-webhook';\nimport { Stack, StackProps, aws_apigateway } from 'aws-cdk-lib';\nimport { Construct } from 'constructs';\nexport class StripeWebhookStack extends Stack {\n constructor(scope: Construct, id: string, props?: StackProps) {\n super(scope, id, props);\n\n const api = new aws_apigateway.RestApi(this, 'Endpoint');\n api.root.addMethod('POST');\n\n if (typeof process.env.SECRET_KEY === 'undefined') {\n throw new Error('environment variable SECRET_KEY undefined');\n }\n const secretKey = SecretKey.fromPlainText(process.env.SECRET_KEY);\n\n const events = ['charge.failed', 'charge.succeeded'];\n\n new StripeWebhook(this, 'StripeWebhook', {\n secretKey,\n url: api.url,\n events,\n logLevel: 'debug',\n });\n }\n}\n```\n\n## API Reference\n\nSee [API.md](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-stripe-webhook/API.md).\n\n## Example\n\nSee more complete [examples](https://github.com/cloudcomponents/cdk-constructs/tree/master/examples).\n\n## License\n\n[MIT](https://github.com/cloudcomponents/cdk-constructs/tree/master/packages/cdk-stripe-webhook/LICENSE)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Create, update and delete stripe webhooks with your app deployment",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://github.com/cloudcomponents/cdk-constructs",
"Source": "https://github.com/cloudcomponents/cdk-constructs.git"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c022bd88d209f8709e67a0d18117f852a92545ca6c5d2edf3e10f0e1717a9ce8",
"md5": "2358fa435d8a31356a62d4459156d979",
"sha256": "ca1e7fa10edf13497879e252fcf06d34b7151ce5c317fc3e36e3ca2cff63c4d1"
},
"downloads": -1,
"filename": "cloudcomponents.cdk_stripe_webhook-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "2358fa435d8a31356a62d4459156d979",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.8",
"size": 3102834,
"upload_time": "2024-04-17T18:36:30",
"upload_time_iso_8601": "2024-04-17T18:36:30.335521Z",
"url": "https://files.pythonhosted.org/packages/c0/22/bd88d209f8709e67a0d18117f852a92545ca6c5d2edf3e10f0e1717a9ce8/cloudcomponents.cdk_stripe_webhook-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "018d9744e394dcef86f02a2620160bc60c4ebabb054b52311c40fa39b720896a",
"md5": "28aaf152f80a8f1b7107f2d25672b6eb",
"sha256": "3e75ee7943ecbc979d88999e34a8ce70a9efe90c73a48eda22db79328a205665"
},
"downloads": -1,
"filename": "cloudcomponents.cdk-stripe-webhook-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "28aaf152f80a8f1b7107f2d25672b6eb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.8",
"size": 3104012,
"upload_time": "2024-04-17T18:36:44",
"upload_time_iso_8601": "2024-04-17T18:36:44.309809Z",
"url": "https://files.pythonhosted.org/packages/01/8d/9744e394dcef86f02a2620160bc60c4ebabb054b52311c40fa39b720896a/cloudcomponents.cdk-stripe-webhook-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 18:36:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cloudcomponents",
"github_project": "cdk-constructs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cloudcomponents.cdk-stripe-webhook"
}