Connect Custom Webhook Data And Headers

Overview

There are two objects when calling the Generate Finicity Connect URL endpoint Generate Finicity Connect URL that you can use to get custom values returned in the Finicity Connect webhooks events:

  • webhookData
  • webhookHeaders

Using The webhookData Object

When passing the webhookData object in the Generate Finicity Connect URL call you will recieve a webhookData object back in all of your Connect Webhook events. For example if you were to send the following webhookData:

Signature Validation
 "webhookData": {
"unquiqueCustomerId": "123456789",
"uniqueRequestId": "234567890"
}

You would get the following response for the started type webhook event:

Signature Validation
 {
"customerId":"1005061234",
"consumerId":"86238nvnw7269e224a4e3de12352d87d",
"eventType":"started",
"eventId":"1495468585434-0e73d1719173766fe4dfe1a8",
"payload":{},
"webhookData": {
"unquiqueCustomerId": "123456789",
"uniqueRequestId": "234567890"
}
}

Using The webhookHeaders Object

Passing the webhookHeaders object provides similar custom return behavior on every webhook event except it will be passed as a header of the return event instead of in the body of the event. An example of a webhookHeaders payload would be:

Event Body
 "webhookHeaders": {
"webhookServerKey": "sadf67ewrkh",
"webhookCustomerSignature": "91l;kj234924987lj"
}

Full Generate Finicity Connect URL Example

Ping Event
 {
"partnerId": "PARTNER_ID",
"customerId": "CUSTOMER_ID",
"type": "aggregation",
"webhookData": {
"unquiqueCustomerId": "123456789",
"uniqueRequestId": "234567890"
},
"webhookHeaders": {
"webhookServerKey": "sadf67ewrkh",
"webhookCustomerSignature": "91l;kj234924987lj"
}
}