StripeResource
Handle
interface StripeResource extends IComputeResource, IResource, IResourceWithArgs, IResourceWithEndpoints, IResourceWithEnvironment, IResourceWithProbes, IResourceWithWaitSupport { webhookSigningSecret: string; withApiKey(apiKey: ParameterResource): StripeResource; withListen( forwardTo: IResourceWithEndpoints, webhookPath?: string, events?: string[]): StripeResource; withListenExternalService( forwardTo: ExternalServiceResource, webhookPath?: string, events?: string[]): StripeResource;}5 members
Properties
property
webhookSigningSecret stringget · setGets the webhook signing secret retrieved from the Stripe CLI.
Methods
Configures the Stripe CLI to use a specific API key from a parameter.
withApiKey(apiKey: ParameterResource): StripeResourceParameters
apiKey ParameterResource The parameter containing the Stripe API key to use.Returns
StripeResource Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.
withListen( forwardTo: IResourceWithEndpoints, webhookPath?: string, events?: string[]): StripeResourceParameters
forwardTo IResourceWithEndpoints The resource to forward webhooks to.webhookPath stringoptional= /webhooks/stripeThe path to the webhook endpoint.eventsstring[]optionalOptional collection of specific webhook events to listen for (e.g., ["payment_intent.created", "charge.succeeded"]). If not specified, all events are forwarded.Returns
StripeResource Configures the Stripe CLI to listen for webhooks and forward them to the specified URL expression.
withListenExternalService( forwardTo: ExternalServiceResource, webhookPath?: string, events?: string[]): StripeResourceParameters
forwardTo ExternalServiceResource The resource to forward webhooks to.webhookPath stringoptional= /webhooks/stripeThe path to the webhook endpoint.eventsstring[]optionalOptional collection of specific webhook events to listen for (e.g., ["payment_intent.created", "charge.succeeded"]). If not specified, all events are forwarded.Returns
StripeResource