Stripe.Scotty

For a typical webhook server implemented with Scotty, probably the only thing you need from this module is one of these two actions:

• requireSig - If your live mode and test mode webhooks use separate URLs.
• requireSig_eitherMode - If your live mode and test mode webhooks use the same URL.

Documentation

requireSig :: (MonadIO m, ScottyError e) => WebhookSecretKey -> ActionT e m ByteString

Terminates request processing if the request does not contain a valid Stripe signature header.

This action returns the request body as a strict byte string; it has to fully evaluate the request body to do the signature check, so we might as well return this information to you for subsequent use.

requireSig_eitherMode :: (MonadIO m, ScottyError e) => BothModes (Maybe WebhookSecretKey) -> ActionT e m (Mode, Value)

Terminates request processing if the request does not contain a valid Stripe signature header.

This action returns the mode and JSON request body; it has to do this much parsing to determine the mode so that we can know which secret key to use in the verification, so we might as well return this information to you for subsequent use.

hasValidSig :: (Monad m, ScottyError e) => WebhookSecretKey -> ByteString -> ActionT e m Bool

Determines whether the request contains a valid Stripe signature header.

getSig :: (Monad m, ScottyError e) => ActionT e m (Maybe Sig)

getSigText :: (Monad m, ScottyError e) => ActionT e m (Maybe Text)