HomeGuidesRecipesAPI Endpoint Reference
Log In
API Endpoint Reference

Update Webhook V2

put
https://api.proof.com/v2/webhooks/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the webhook to be updated.

Body Params
string
required
length ≤ 5000

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

string | null

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

string | null

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

headers
array of strings | null

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.

headers
string | null

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

oauth_config
object | null

OAuth 2.0 client-credentials block. Supply either this object or an API key/header to authenticate incoming webhook requests.

subscriptions
array of strings
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.

subscriptions*
Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago