Setting Up and Using Webhooks in Prado

Webhooks allow external systems to receive real-time notifications when specific events occur in Prado. This enables seamless integrations with platforms such as Zapier, Slack, CRMs, or custom applications.

How to Access Webhooks

To create and manage webhooks in Prado:

  1. Navigate to Admin Classic.
  2. Go to IT > Integrations > Webhooks.
  3. Click Add Webhook.
  4. Choose the event you want to trigger the webhook (e.g., Order Paid).
  5. Enter the URL where the webhook should be sent.
  6. Click Save.

Available Webhook Events

The following webhook events are currently supported:

Event Name Description
Customer Created Triggered when a new customer is created
Order Cancelled Triggered when an order is cancelled
Order Fulfilled Triggered when an order is fulfilled
Order Packed Triggered when an order is packed
Order Paid Triggered when payment is completed
Subscription Cancelled Triggered when a subscription is cancelled

Webhook Payloads (Response Bodies)

🧑 Customer Webhook Payload

{
  "event": "CustomerCreated",
  "customerId": "00000000-0000-0000-0000-000000000000",
  "customerNumber": "C12345",
  "phoneNumber": "+15551234567",
  "email": "customer@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "source": "Website"
}
{
  "Event": "CustomerCreated",
  "CreatedDateUtc": "2024-05-01T12:00:00Z",
  "CustomerId": "1ae76366-0b78-45a1-98e2-2b21df0e4bb5",
  "CustomerNumber": 1,
  "PhoneNumber": "2105551234",
  "Email": "john@example.com",
  "FirstName": "John",
  "LastName": "Doe",
  "Source": "AccountSignUp",
  "FullName": "John Doe"
}

 

💰 Order Webhook Payload

{
  "event": "OrderPaid", // Or OrderCancelled, OrderFulfilled, etc.
  "Type": "WebsitePurchase",
  "FulfillmentMethod": "InStorePickup",
  "StoreId": "c6f141f1-7f54-4c03-9a44-054780fb3079",
  "IsSubscription": false,
  "SubscriptionId": null,
  "CustomerId": "1ae76366-0b78-45a1-98e2-2b21df0e4bb5",
  "FirstName": "John",
  "LastName": "Doe",
  "PhoneNumber": "2105551234",
  "Email": "john@example.com",
  "ZipCode": "22144",
  "PromotionCode": "SUMMER2024",
  "FullName": "John Doe"
}

📦 Order Packed Webhook Payload

{
  "Event": "OrderPacked",
  "CreatedDateUtc": "2024-05-01T12:00:00Z",
  "SubscriptionId": "75a0b823-3bcd-4ceb-9625-a4926718ff60",
  "CustomerId": "1ae76366-0b78-45a1-98e2-2b21df0e4bb5",
  "CustomerNumber": 1,
  "FirstName": "John",
  "LastName": "Doe",
  "PhoneNumber": "2105551234",
  "Email": "john@example.com",
  "OrderId": "b1f1c21d-4363-4f7c-a807-0a15332d88a0",
  "OrderNumber": 1001
}

🔁 Subscription Webhook Payload

{
  "event": "SubscriptionUpdated", // Or SubscriptionCancelled
  "CreatedDateUtc": "2024-05-01T12:00:00Z",
  "SubscriptionId": "75a0b823-3bcd-4ceb-9625-a4926718ff60",
  "CustomerId": "1ae76366-0b78-45a1-98e2-2b21df0e4bb5",
  "CustomerNumber": 1,
  "PhoneNumber": "2105551234",
  "Email": "john@example.com",
  "FirstName": "John",
  "LastName": "Doe"
}

 

Need more help? Send us an email at support@getprado.com and we'll be happy to assist you! 

 

 


Knowledge Base Software powered by Helpjuice