Download the PHP package aerni/snipcart-webhooks without Composer
On this page you can find all versions of the php package aerni/snipcart-webhooks. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download aerni/snipcart-webhooks
More information about aerni/snipcart-webhooks
Files in aerni/snipcart-webhooks
Package snipcart-webhooks
Short Description Receive and work with Snipcart webhooks in Laravel
License MIT
Homepage https://github.com/aerni/snipcart-webhooks
Informations about the package snipcart-webhooks
Laravel Snipcart Webhooks
This package makes it super easy to setup and work with Snipcart webhooks in your Laravel application.
Installation
Install the package using Composer.
Set your Snipcart Live Secret
and Test Secret
in your .env
. You can find them in your Snipcart Dashboard.
You may also publish the config of the package.
The following config will be published to config/snipcart-webhooks.php
.
Basic Usage
- Register a webhook receiving route
- Create Event Listeners or Subscribers to listen for Snipcart Events.
Routing
Go to your Snipcart Dashboard and configure the URL where you want to receive the webhook requests. Register that route in routes/web.php
using the provided Route::snipcart
macro.
This will register a POST
route to a controller provided by this package. The route will be registered without the VerifyCsrfToken
middleware, because Snipcart has no way of getting a csrf-token.
Events & Listeners
Each incoming Snipcart webhook request will trigger its corresponding Laravel Event. Create and register one or more Event Listeners or Subscribers and do your magic.
Overview
Laravel Events | Snipcart Events |
---|---|
OrderCompleted | order.completed |
OrderStatusChanged | order.status.changed |
OrderPaymentStatusChanged | order.paymentStatus.changed |
OrderTrackingNumberChanged | order.trackingNumber.changed |
OrderRefundCreated | order.refund.created |
OrderNotificationCreated | order.notification.created |
SubscriptionCreated | subscription.created |
SubscriptionCancelled | subscription.cancelled |
SubscriptionPaused | subscription.paused |
SubscriptionResumed | subscription.resumed |
SubscriptionInvoiceCreated | subscription.invoice.created |
InvalidSignature |
OrderCompleted
Aerni\SnipcartWebhooks\Events\OrderCompleted
Dispatched whenever a new order is completed.
OrderStatusChanged
Aerni\SnipcartWebhooks\Events\OrderStatusChanged
Dispatched whenever the status of an order changes.
OrderPaymentStatusChanged
Aerni\SnipcartWebhooks\Events\OrderPaymentStatusChanged
Dispatched whenever the payment status of an order changes.
OrderTrackingNumberChanged
Aerni\SnipcartWebhooks\Events\OrderTrackingNumberChanged
Dispatched whenever the tracking number of an order changes.
OrderRefundCreated
Aerni\SnipcartWebhooks\Events\OrderRefundCreated
Dispatched whenever an order is refunded.
OrderNotificationCreated
Aerni\SnipcartWebhooks\Events\OrderNotificationCreated
Dispatched whenever a notification is added to an order.
SubscriptionCreated
Aerni\SnipcartWebhooks\Events\SubscriptionCreated
Dispatched whenever a new subscription is created.
SubscriptionCancelled
Aerni\SnipcartWebhooks\Events\SubscriptionCancelled
Dispatched whenever a subscription is cancelled.
SubscriptionPaused
Aerni\SnipcartWebhooks\Events\SubscriptionPaused
Dispatched whenever a subscription is paused.
SubscriptionResumed
Aerni\SnipcartWebhooks\Events\SubscriptionResumed
Dispatched whenever a subscription is resumed.
SubscriptionInvoiceCreated
Aerni\SnipcartWebhooks\Events\SubscriptionInvoiceCreated
Dispatched whenever a new invoice is added to an existing subscription.
InvalidSignature
Aerni\SnipcartWebhooks\Events\InvalidSignature
Dispatched whenever the signature of the webhook request is invalid.
Tests
Run the tests like this: