Skip to content

Update webhook secret

PUT
/v1/integrator/webhook-secret

Updates the webhook secret used for signing webhook payloads.

Webhook Security: Each webhook request is signed using HMAC SHA256. The signature is computed from the exact JSON payload and included in the Signature HTTP header.

Verification: Compute the HMAC signature using your secret and the raw request body, then compare it to the Signature header before processing.

If no webhook secret is set, webhook requests will not include a Signature header.

object
secret
required

The secret key used to compute HMAC SHA256 signatures for webhook payloads. The signature is included in the Signature HTTP header of each webhook request.

string
>= 1 characters

Response for status 200

Response for status 401

object
type

A URI reference that identifies the problem type

string
default: about:blank
title
required

A short, human-readable summary of the problem type

string
status
required

The HTTP status code

number
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
realm

The authentication realm

string
scope

The required scope for this resource

string

Response for status 404

object
type

A URI reference that identifies the problem type

string
default: about:blank
title
required

A short, human-readable summary of the problem type

string
status
required

The HTTP status code

number
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
resourceType
required

The type of resource that was not found

string
resourceId
required

The identifier of the resource that was not found

string

Response for status 500

object
type

A URI reference that identifies the problem type

string
default: about:blank
title
required

A short, human-readable summary of the problem type

string
status
required

The HTTP status code

number
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string