Webhooks provide a way for users to receive notifications from the software when certain events occur. Initially, we will only offer the "IndexTaken" event.
IndexTaken Webhook
This webhook is an account wide event for when an Index Taker completes a Kolbe Index regardless of type of Index and the individual taking the index.
In order to leverage this webhook, a subscription to Core Pro will be required. The SuperAdmin will be able to add the appropriate code for running the event. Keep in mind that experience webhook developers should be the ones to configure the webhook. If assistance is needed, support will be provided by the Kolbe Tech Team. However, if the issue resides on the external platform, the Kolbe Tech Team might not be able to resolve the issue.
Basic Setup Process
Users will add a valid URL (https://theirsite.com/webhook)
Users may add additional headers
When a user completes an index, the software will evaluate if this feature is turned on for the account. If the feature is turned on, the software will send an HTTPS POST to the user-defined end point.
Example Post Schema
{
"firstName": "John",
"lastName": "Doe",
"nameId": "701038000000",
"personGUID": "FC1A5602-BBAA-C08C-ACEC85847EC88843",
"emailAddress": "john.doe@example.com",
"customId": "FC1A5603-0C67-598B-0FA910A721FE0EF5",
"MO": "2-6-8-4",
"indexType": "A",
"dateTaken": "2021-01-01",
"timeStampMS": 1763077536717,
"accountNumber": "701038",
"resultsLink": "",
"eventType": "IndexTaken"
}
