Webhooks

For our 1.16 release, we have added webhook objects and have deprecated webhook events.

The new format will pass back data along with the webhook.

The available events you will receive are:

Event Type	Description and Triggers
SubscriptionCreated	An attempt to create subscription was successful. Triggers when a subscription creation is going to be created using the following end points: Create Subscription (POST /api/Subscriptions) Create Customer (POST /api/Customers) when subscriptions are going to be created Create Subscription (POST /api/Customers/customerId/subscriptions) Create Checkout (POST /api/Checkout)
SubscriptionChanged	Update Subscription (PUT /api/Subscriptions/{{Active Subscription Id}})
SubscriptionFailed	An attempt to create subscription was unsuccessful.
~~ACHInvoiceStatusChanged~~ deprecated - use InvoiceStatusChanged	The webhook is triggered on any status change of an invoice that is going to be paid with ACH payment method. Initial status assignment is NOT considered as “status change”. Notes: Please use InvoiceStatusChanged. This Webhook will be deprecated in the future.
InvoiceCreated	The webhook is triggered when an invoice is created in the system The event should have InvoiceCreated type Notes: one-time payment invoices recurrent payment invoices installments payment invoices
InvoiceStatusChanged	The webhook is triggered on any status change of an invoice. Initial status assignment is NOT considered as “status change”. Notes: status of the invoice can be changed by Update Invoice request (Update an invoice by invoice Id that is currently in the 'Pending' or 'Recycle' state) webhook should be triggered for Refund invoices as well (incl. changes from Pending to Refund / PartialRefund / RefundPending / RefundDeclined / RefundFailed statuses) webook should be triggered for one time payments and recurrent invoices
InvoiceAttemptCreated (RecordId is InvoiceId)	The webhook is triggered when an invoice attempt is created in the system Notes: incl. one-time payment invoices recurrent payment invoices installments payment invoices
InvoiceAttemptStatusChanged (RecordId is InvoiceId)	The webhook is triggered on any status change of an invoice attempt. Initial status assignment is NOT considered as “status change”. Notes: webhook should be triggered for Refund invoices as well (incl. changes from Pending to Refund / PartialRefund / RefundPending / RefundDeclined / RefundFailed statuses) webook should be triggered for one time payments and recurrent (subscription or installment) invoices
WebhookTest	During Setup - a test webhook is sent

Webhook payload examples:

Subscription Created

{
  "Body": "{\"Subscription\":{\"SubscriptionId\":2691,\"CustomerId\":9687,\"MerchantSubscriptionRefId\":\"1234-5678-9101\",\"NetworkTransactionId\":null,\"BillingFrequencyType\":\"Daily\",\"SubscriptionStatusType\":\"Current\",\"SubscriptionCancelType\":\"Immediate\",\"InitialBillDate\":\"4/26/2024\",\"NextBillDate\":\"1/28/2025\",\"TaxAddress\":null,\"PaymentMethodIds\":[25953],\"CancelledAt\":null,\"BillingPlans\":[{\"SubscriptionBillingPlanId\":3117,\"SubscriptionId\":2691,\"Name\":\"Billing Plan 1\",\"Value\":10.99,\"StartDate\":\"4/26/2024\",\"CyclesRemaining\":-1,\"CycleCount\":-1,\"ValueType\":\"Standard\"}],\"Message\":null,\"ProcessorRawResponse\":null},\"EventDateTime\":\"2025-01-28T18:09:27.6118027Z\",\"EventType\":\"SubscriptionCreated\",\"RevolvMerchantId\":579}",
  "Entropy": "4be04dcd-5b61-4608-9d81-c2cf9748ec76"
}

Subscription Changed

{
  "Body": "{\"Subscription\":{\"SubscriptionId\":2691,\"CustomerId\":9687,\"MerchantSubscriptionRefId\":\"YourSubscriptionId-123\",\"NetworkTransactionId\":null,\"BillingFrequencyType\":\"Monthly\",\"SubscriptionStatusType\":\"Recycle\",\"SubscriptionCancelType\":\"Immediate\",\"InitialBillDate\":\"4/26/2024\",\"NextBillDate\":\"2/17/2025\",\"TaxAddress\":null,\"PaymentMethodIds\":[25953],\"CancelledAt\":null,\"BillingPlans\":[{\"SubscriptionBillingPlanId\":3117,\"SubscriptionId\":2691,\"Name\":\"Billing Plan 1\",\"Value\":10.99,\"StartDate\":\"4/26/2024\",\"CyclesRemaining\":-1,\"CycleCount\":-1,\"ValueType\":\"Standard\"}],\"Message\":null,\"ProcessorRawResponse\":null},\"EventDateTime\":\"2025-01-28T18:14:37.5805028Z\",\"EventType\":\"SubscriptionChanged\",\"RevolvMerchantId\":579}",
  "Entropy": "d18771c5-ee64-4aec-8129-6e2a8fa4ea57"
}

Invoice created

{
  "Body": "{\"Invoice\":{\"InvoiceId\":330973,\"ParentInvoiceId\":null,\"CustomerId\":null,\"MerchantInvoiceRefId\":\"ABC12345DProbVs1\",\"PaymentMethod\":{\"PaymentMethodId\":7836,\"BillingAddressId\":9020,\"BillingFirstName\":\"Robert\",\"BillingLastName\":\"Podlesni\",\"MerchantPaymentMethodRefId\":null,\"BillingAddress\":{\"AddressId\":9020,\"AddressLine1\":\"32 Coppercrest\",\"AddressLine2\":null,\"City\":\"Aliso Viejo\",\"State\":\"CA\",\"PostalCode\":\"92656\",\"PhoneNumber\":null,\"Email\":null,\"Country\":\"US\"},\"PaymentMethodAchDetails\":null,\"PaymentMethodCreditCardDetails\":{\"BinNumber\":\"411111\",\"PaymentLast4Digit\":\"1111\",\"PaymentExpirationDate\":\"1130\"}},\"InvoiceStatus\":\"OneTimePaymentPending\",\"Subtotal\":0.13,\"Tax\":0,\"Total\":0.13,\"BillingDate\":\"1/27/2025\",\"MerchantLegalName\":\"[TEST} House Nuvei \",\"MerchantCustomerRefId\":null,\"CustomerFirstName\":null,\"CustomerLastName\":null,\"SubscriptionId\":null,\"InstallmentId\":null,\"EligibilityFailReason\":null,\"MerchantSubscriptionRefId\":null,\"NetworkTransactionId\":null,\"InvoiceLineItems\":[],\"InvoiceAttempts\":[],\"InvoiceStatusEnum\":\"OneTimePaymentPending\"},\"EventDateTime\":\"2025-01-27T18:18:45.0782738Z\",\"EventType\":\"InvoiceCreated\",\"RevolvMerchantId\":579}",
  "Entropy": "a5673ed2-93f5-491c-87df-6548edb20b39"
}

Invoice status changed

{
  "Body":"{\u0022Invoice\u0022:{\u0022InvoiceId\u0022:330973,\u0022ParentInvoiceId\u0022:null,\u0022CustomerId\u0022:null,\u0022MerchantInvoiceRefId\u0022:\u0022ABC12345DProbVs1\u0022,\u0022PaymentMethod\u0022:{\u0022PaymentMethodId\u0022:7836,\u0022BillingAddressId\u0022:9020,\u0022BillingFirstName\u0022:\u0022Robert\u0022,\u0022BillingLastName\u0022:\u0022Podlesni\u0022,\u0022MerchantPaymentMethodRefId\u0022:null,\u0022BillingAddress\u0022:{\u0022AddressId\u0022:9020,\u0022AddressLine1\u0022:\u002232 Coppercrest\u0022,\u0022AddressLine2\u0022:null,\u0022City\u0022:\u0022Aliso Viejo\u0022,\u0022State\u0022:\u0022CA\u0022,\u0022PostalCode\u0022:\u002292656\u0022,\u0022PhoneNumber\u0022:null,\u0022Email\u0022:null,\u0022Country\u0022:\u0022US\u0022},\u0022PaymentMethodAchDetails\u0022:null,\u0022PaymentMethodCreditCardDetails\u0022:{\u0022BinNumber\u0022:\u0022411111\u0022,\u0022PaymentLast4Digit\u0022:\u00221111\u0022,\u0022PaymentExpirationDate\u0022:\u00221130\u0022}},\u0022InvoiceStatus\u0022:\u0022Paid\u0022,\u0022Subtotal\u0022:0.13,\u0022Tax\u0022:0,\u0022Total\u0022:0.13,\u0022BillingDate\u0022:\u00221/27/2025\u0022,\u0022MerchantLegalName\u0022:\u0022[TEST} House Nuvei \u0022,\u0022MerchantCustomerRefId\u0022:null,\u0022CustomerFirstName\u0022:null,\u0022CustomerLastName\u0022:null,\u0022SubscriptionId\u0022:null,\u0022InstallmentId\u0022:null,\u0022EligibilityFailReason\u0022:null,\u0022MerchantSubscriptionRefId\u0022:null,\u0022NetworkTransactionId\u0022:\u0022480213756277396\u0022,\u0022InvoiceLineItems\u0022:[],\u0022InvoiceAttempts\u0022:[{\u0022InvoiceAttemptId\u0022:160406,\u0022Amount\u0022:0.13,\u0022InvoiceAttemptStatus\u0022:\u0022Success\u0022,\u0022InvoiceAttemptDate\u0022:\u00222025-01-27T18:18:48.2210112Z\u0022,\u0022PaymentProcessor\u0022:\u0022Nuvei\u0022,\u0022ProcessorTransactionId\u0022:\u00227110000000009866741\u0022,\u0022ResponseCode\u0022:\u0022APPROVED\u0022,\u0022ResponseMessage\u0022:\u0022APPROVED\u0022,\u0022ProcessorRawResponse\u0022:null,\u0022PaymentMethod\u0022:{\u0022PaymentMethodId\u0022:7836,\u0022BillingAddressId\u0022:9020,\u0022BillingAddress\u0022:{\u0022AddressId\u0022:9020,\u0022AddressLine1\u0022:\u002232 Coppercrest\u0022,\u0022AddressLine2\u0022:null,\u0022City\u0022:\u0022Aliso Viejo\u0022,\u0022State\u0022:\u0022CA\u0022,\u0022PostalCode\u0022:\u002292656\u0022,\u0022PhoneNumber\u0022:null,\u0022Email\u0022:null,\u0022Country\u0022:\u0022US\u0022},\u0022BillingFirstName\u0022:\u0022Robert\u0022,\u0022BillingLastName\u0022:\u0022Podlesni\u0022,\u0022MerchantPaymentMethodRefId\u0022:null,\u0022PaymentMethodAchDetails\u0022:null,\u0022PaymentMethodCreditCardDetails\u0022:{\u0022BinNumber\u0022:\u0022411111\u0022,\u0022PaymentLast4Digit\u0022:\u00221111\u0022,\u0022PaymentExpirationDate\u0022:\u00221130\u0022}},\u0022EligibilityCheckOrderCode\u0022:null,\u0022ProcessorMerchantId\u0022:\u002233762194017370\u0022}],\u0022InvoiceStatusEnum\u0022:\u0022Paid\u0022},\u0022EventDateTime\u0022:\u00222025-01-27T18:18:48.3105823Z\u0022,\u0022EventType\u0022:\u0022InvoiceStatusChanged\u0022,\u0022RevolvMerchantId\u0022:579}",
  "Entropy":"b39d4914-cb32-46d0-b3ab-e832539d3d7b"
}

Invoice attempt created

{
  "Body": "{\"Attempt\":{\"InvoiceId\":330973,\"SubscriptionId\":0,\"InstallmentId\":0,\"ProcessorMerchantId\":\"33762194017370\",\"InvoiceAttemptId\":160406,\"Amount\":0.13,\"InvoiceAttemptStatus\":\"Success\",\"InvoiceAttemptDate\":\"2025-01-27T18:18:48.2210112Z\",\"PaymentProcessor\":\"Nuvei\",\"ProcessorTransactionId\":\"7110000000009866741\",\"ResponseCode\":\"APPROVED\",\"ResponseMessage\":\"APPROVED\",\"ProcessorRawResponse\":null,\"PaymentMethod\":{\"PaymentMethodId\":7836,\"BillingAddressId\":9020,\"BillingAddress\":{\"AddressId\":9020,\"AddressLine1\":\"32 Coppercrest\",\"AddressLine2\":null,\"City\":\"Aliso Viejo\",\"State\":\"CA\",\"PostalCode\":\"92656\",\"PhoneNumber\":null,\"Email\":null,\"Country\":\"US\"},\"BillingFirstName\":\"Robert\",\"BillingLastName\":\"Podlesni\",\"MerchantPaymentMethodRefId\":null,\"PaymentMethodAchDetails\":null,\"PaymentMethodCreditCardDetails\":{\"BinNumber\":\"411111\",\"PaymentLast4Digit\":\"1111\",\"PaymentExpirationDate\":\"1130\"}},\"EligibilityCheckOrderCode\":null},\"EventDateTime\":\"2025-01-27T18:18:48.3407882Z\",\"EventType\":\"InvoiceAttemptCreated\",\"RevolvMerchantId\":579}",
  "Entropy": "813a9c7a-b243-49b0-9708-6cae966817d1"
}

Invoice attempt status changed

{
  "Body": "{\"Attempt\":{\"InvoiceId\":331122,\"SubscriptionId\":2692,\"InstallmentId\":0,\"ProcessorMerchantId\":\"33762194017370\",\"InvoiceAttemptId\":160541,\"Amount\":10.99,\"InvoiceAttemptStatus\":\"Fail\",\"InvoiceAttemptDate\":\"2025-01-28T18:15:46.2660036Z\",\"PaymentProcessor\":\"Nuvei\",\"ProcessorTransactionId\":\"7110000000009950160\",\"ResponseCode\":\"-1\",\"ResponseMessage\":\"Decline\",\"ProcessorRawResponse\":null,\"PaymentMethod\":{\"PaymentMethodId\":25954,\"BillingAddressId\":27426,\"BillingAddress\":{\"AddressId\":27426,\"AddressLine1\":\"100 Main Street\",\"AddressLine2\":\"\",\"City\":\"Irvine\",\"State\":\"CA\",\"PostalCode\":\"92602\",\"PhoneNumber\":null,\"Email\":null,\"Country\":\"US\"},\"BillingFirstName\":\"John\",\"BillingLastName\":\"Doe\",\"MerchantPaymentMethodRefId\":\"payment-method-ref-id_hgays-213-44d\",\"PaymentMethodAchDetails\":null,\"PaymentMethodCreditCardDetails\":{\"BinNumber\":\"445700\",\"PaymentLast4Digit\":\"0005\",\"PaymentExpirationDate\":\"1025\"}},\"EligibilityCheckOrderCode\":null},\"EventDateTime\":\"2025-01-28T18:15:49.7836702Z\",\"EventType\":\"InvoiceAttemptStatusChanged\",\"RevolvMerchantId\":579}",
  "Entropy": "5b9e1df5-d753-4489-bfa5-ac886d3a3348"
}

Webhook Test

{
  "Body": "{\"EventDateTime\":\"2025-01-27T16:37:42.3029596Z\",\"EventType\":\"WebhookTest\",\"RevolvMerchantId\":119}",
  "Entropy": "2c6c52f6-622d-46e1-ae79-d7991020c332"
}

Each Event has following attributes:

Attribute	Description
Body	A Serialized string of a JSON object. This will include 'EventType' and 'RevolvMerchantId
Entropy	A random string to make the payload more cryptographically secure