Skip to content
ValidationCheck

Rotate an endpoint's signing secret

POST
/v1/webhook-endpoints/{id}/rotate-secret
curl --request POST \
  --url https://api.validationcheck.net/v1/webhook-endpoints/example/rotate-secret \
  --header 'Authorization: Bearer <token>'

The old secret stops working immediately; deliveries already queued are signed with the new one.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Rotated

Media typeapplication/json
object
success
required
boolean
data
required
object
id
required
string
url
required
string
description
required
string | null
events
required

Event types, or [“*”] for all.

Array<string>
format
required

Json: signed JSON payload. slack / discord: a chat message for an incoming-webhook URL.

string
Allowed values: json slack discord
status
required
string
Allowed values: enabled disabled
disabled_reason
required

“failing” when turned off after a day of failed deliveries.

string | null
created_at
required
string
secret
required

Signs every delivery (VC-Signature). Shown only when created or rotated.

string

Example 

{
  "success": true,
  "data": {
    "id": "we_3f9c…",
    "format": "json",
    "status": "enabled"
  }
}

400

Section titled “400”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}

401

Section titled “401”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}

403

Section titled “403”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}

404

Section titled “404”

Error

Media typeapplication/json
object
success
required
boolean
error
required
object
code
required
string
Allowed values: INVALID_REQUEST INVALID_INPUT MISSING_FIELD UNAUTHORIZED INSUFFICIENT_CREDITS FORBIDDEN_SCOPE ACCOUNT_SUSPENDED NOT_FOUND IDEMPOTENCY_CONFLICT INPUT_LIMIT_EXCEEDED RATE_LIMITED INTERNAL_ERROR UPSTREAM_UNAVAILABLE MAINTENANCE
message
required
string
docs_url
required
string format: uri
request_id
required
string

Example 

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST"
  }
}