Webhook Request

When an event has been triggered in Sageworks for which a webhook is configured, a webhook request will be created and added to our webhook queue. The request will be sent to the URL configured for the webhook.

Webhook Request Format

POST
 
abrigo-webhook-key: dfjrtu4867fh34dfhi
 
{
   "webhookId": "6f650693-6f71-4323-b22c-ccc7f79f8b74",
   "webhookRequestId": "1e000712-1b71-7461-b11c-abc1f09f0b41",
   "eventType": "LoanDescriptionUpdated",
   "payload": {
      "loanId": 123
   }
}

Header
abrigo-webhook-key - the secret key that is configured for the webhook in Sageworks will be included in a header with the name "abrigo-webhook-key" and can be checked prior to processing a webhook request.

Body

webhookId - this is the ID of the webhook in Sageworks. This will be included with every webhook request that this webhook triggers, allowing consumers of webhook requests to know which webhook triggered a specific request.
webhookRequestId - this is the id of the specific webhook request. Each time a webhook triggers a request, it will be given a unique webhookRequestId.
eventType - the type of event that triggered the webhook request. The event type will determine the data that is included in the payload.
payload - this is the data or the event that triggered the webhook. The data that is included will be different depending on the type of event.

Request Status

Webhook Request Success
If a 2XX response status code is returned when we make our webhook request to the configured URL, we assume that the webhook has been successfully delivered, and will not try to deliver the webhook again.

Webhook Request Failure
If a response status code of anything other than 2XX is received, or if a response is not received after 60 seconds, the webhook request attempt is considered to be failed.

Webhook Request Retry
If a webhook request fails, it will be retried after 5 minutes. If the webhook request cannot be delivered after 7 attempts, no further attempts to deliver the webhook request will be made.