On This Page

Webhook Notification Header and Message Body Descriptions

Each webhook notification for an event update contains headers and a message body with fields. This section describes the possible fields and values you can receive in a notification.

Notification Headers

These headers are sent in every notification. Some headers contain duplicate information from the fields in the message body.
V-C-signature
The digital signature, which you can use to validate the security of the notification.
V-C-event-type
The type of event that generated the notification.
V-C-organization-id
The identifier of the organization that is subscribed to the notification.
V-C-product-name
The name of the product for which the event occurred.
V-C-request-type
The indicator of whether the notification is new or a retry attempt.
V-C-retry-count
The number of times the notification was resent.
V-C-transaction-trace-id
The identifier of the notification attempt. Every retry attempt has a unique transaction trace ID. The notification ID remains the same.
v-c-webhook-id
The identifier of the webhook subscription that generated the notification.

Notification Message Body

The message body contains fields associated with the notification and the payload of the event that generated the notification.
webhookId
The identifier of the webhook subscription that generated the notification.
transactionTraceId
The identifier of the notification attempt. Every retry attempt has a unique transaction trace ID. The notification ID remains the same.
productId
The identifier of the product that generated the event.
organizationId
The identifier of the organization that is subscribed to the notification.
eventType
The type of event that generated the notification.
eventDate
The timestamp of when the event occurred.
payload
The data generated by the event.
requestType
The indicator of whether the notification is new or a retry attempt.

Example: Webhook Notification

This is an example of a received webhook notification. Use this example to know what your system can expect when you receive a notification.
Invoicing Webhook Notification
POST /test HTTP/1.1
Host: invoicetest.example.com
Content-Length: 1647
Content-Type: application/json
User-Agent: Vert.x-WebClient/3.9.8
V-C-Event-Type: invoicing.customer.invoice.send
V-C-Organization-Id: invoicetest
V-C-Product-Name: customerInvoicing
V-C-Request-Type: NEW
V-C-Retry-Count: 0
V-C-Signature: t=168506218354;keyId=facdaf45-db00-233c-e053-5a588d0a743a;sig=kJgSHwHrRgUmXJdaSSqtPVzOTMlV3SW90WAFIfPj4XA=
V-C-Transaction-Trace-Id: 8c01a8e9b3334d19528d9b69a21fe797ebaf8dd3dee52f422dd699af26bd866-0
V-C-Webhook-Id: fc8a9385-723e8e28-e053-a2588e0a536d

{
   "notificationId":"fc8f1cae-1232-5dd-e053-a0588e0a5eeb",
   "retryNumber":0,
   "eventType":"invoicing.customer.invoice.send",
   "eventDate":"2023-05-25T17:49:40.309-07:00",
   "webhookId":"fc8a9385-723e-8e28-e053-a2588e0a536d",
   "payloads":[
      {
         "data":{
            "merchantZip":"12345",
            "thankYou":"Thank you for your business!",
            "subject":"You've received an invoice 202203789 from Company, Inc.",
            "dueDate":"2023-05-25",
            "link":"Click the link below to view and pay the invoice.",
            "body":"You have a new invoice from Company, Inc. for 102.00 ALL due on 2023-05-25.",
            "merchantState":"OH",
            "merchantName":"Company, Inc.",
            "button":"VIEW AND PAY INVOICE",
            "invoiceBalance":"102.00",
            "merchantAddress2":" ",
            "invoiceNumber":"20220389",
            "payerName":"Firstname Lastname",
            "customMessage":"Thank you for your business. By clicking the view and pay invoice you agree to the terms and conditions here: https://paymenttermsandconditions.example.com",
            "currency":"ALL",
            "merchantCity":"Placeville",
            "emailTo":"Person@example.com",
            "eventType":"invoicing.customer.invoice.send",
            "balanceAmount":"102.00",
            "organizationID":"invoicetest",
            "merchantPhone":"321-321-3211",
            "emailLanguage":"en-us",
	     "invoiceUrl":"
https://businesscentertest.visaacceptance.com
/ebc2/invoicing/payInvoice/u2wJqUKII4FsqtIrZx51lUuvYr5Msz23nqIx12xqJhs7wqT6Th2mJcDOYHSC5hE?version=v2.1",
            "merchantAddress":"39 E. Road St",
            "correlationID":"dceb3ce-d787-453c-84a3-ce33b141cc76",
            "hello":"Hello Person,"
         },
         "preferences":{
            "contacts":[
               {
                  "firstName":"Invoicing",
                  "lastName":"Email",
                  "contact":"person@example.com",
                  "type":"EMAIL"
               }
            ]
         },
         "organizationId":"invoicetest",
         "metadata":{
            "from.displayName":"Company, Inc.",
            "reply.email":"noreply@example.com",
            "sentBy":"Invoice"
         }
      }
   ]
}