Webhooks

Create Webhook V2

Request body

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")

request_id_header_namestring nullable

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

headersstring[] nullable

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]"]). If passed, value for header (singular) is ignored.

signing_keystring nullable

A signing key to sign the webhook payloads with. This is used to verify the authenticity of the webhook requests. If not passed and if using api keys to authenticate, Proof will use the api key to sign the payloads. https://dev.proof.com/docs/webhooks-v2#security

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.

Example request

{
  "url": "https://www.yourapp.com/proof_webhooks",
  "header": "X-Custom-Header:X-Custom-Key",
  "subscriptions": [
    "transaction.*"
  ]
}

Response

Webhook created

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