Webhooks

nCino Mortgage offers a variety of events that can have subscriptions created for them. These can be useful to be notified of different events that occur within the nCino Mortgage platform and keep you informed of updates.

Setting up a Webhook Listener

Prior to setting up a webhook subscription a webhook listener will need to be set up to allow the webhook to POST notifications of subscribed events.

The URL of this listener will be needed during the setup process.

When receiving an event the listener should:

• Respond with a 201 - Ok, if the event was successfully received.
• If a 200 is not received, nCino Mortgage will attempt to resend the notification at a future point.

For more information on retries, see Webhook Retry and Resend

Setting up a Webhook

To setup a webhook, navigate to the API Management Area and click on the Webhooks Tab.

On the webhooks page, any webhooks that have already been created will be listed. If this is your first webhook, a view like above will be shown with an option to add a new Webhook.

To create a new webhook:

1. Click "Add Webhook"

2. Enter a name for the Webhook. It’s suggested this is descriptive, such as the vendor/service or application that will be consuming the event notifications.
3. Enter the callback URL for the webhook listener.
4. Add one or more events to subscribe to.
5. Click Save Webhook

📘

Webhooks can also be managed programmatically via API Endpoints.

See API Documentation for more information. In order to use these endpoints a set of API credentials must be authorized to interact with the webhook endpoints.

Validating Received Webhooks

Webhook Secret

After the creation of a webhook, a webhook secret will be generated. This secret will be returned in the response of the API request for webhook creation, if creating the webhook through the API, or by clicking the corresponding row or selecting View Details from the three-dot menu on the right side of the corresponding row.

Validating a Webhook is from nCino Mortgage

Each event which is sent from nCino Mortgage to the corresponding will contain a x-api-signature field in the header. This value is derived by two different values:

• Webhook Secret
• RAW JSON Body of the Webhook

To generate the signature value, use the webhook secret and the RAW JSON body of the webhook and run it through a HMAC SHA 256 generator. This will generate the x-api-signature value. If the signature does not match, ensure the correct secret is being used and the RAW JSON is being used.

Programmatic Creation of Webhooks and Subscriptions

API endpoints are offered to manage the programmatic creation of webhooks and subscriptions of events.