Webhooks

Get Webhook V2

get/mortgage/v2/webhooks/{id}

Request

  • Base URL: https://api.proof.com
  • URL: https://api.proof.com/mortgage/v2/webhooks/{id}
  • Auth: API key in header ApiKey

Path parameters

idstring required

The identifier of the webhook to be retrieved.

Response

Webhook retrieved

idstring required

The ID of the Webhook V2 object.

urlstring required

Proof will make a POST request to this URL for every subscribed event.

headerstring nullable

A header value to pass through every request Proof makes back to your webhook URL. This can be required authentication to your system for security purposes. (E.g. "header": "X-Custom-Header:X-Custom-Key")

headersstring[]

A list of header values to pass through every request Proof makes back to your webhook URL. This can be required authentication to your system for security purposes. (E.g. "headers": ["[X-Custom-Header]:[X-Custom-Key]"])

enabledboolean required

A boolean value to indicate if the webhook is active.

request_id_header_namestring

The name of the header that will contain the request ID for each webhook request. Defaults to X-Request-Id.

request_id_header_value_templatestring nullable
subscriptionsstring[] required

An array containing the desired events that Proof should POST a webhook for. See our Webhooks V2 guide for a list of valid subscriptions.

Changes

No recorded changes to this operation across all 1 revision of this API.