Skip to content
Asqary Docs

Rotate the signing secret

POST
/v1/webhooks/{webhook_id}/rotate-secret
curl --request POST \
  --url https://api-staging.asqary.com/v1/webhooks/example/rotate-secret \
  --header 'Authorization: Bearer <token>'

Issues a new secret, returned once. For 24 hours deliveries carry a signature from both the old and the new secret, so receivers can switch without dropping events.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
webhook_id
required
string
/^wh_[0-9a-f]{32}$/

Responses

Section titled “Responses”

200

Section titled “200”

The endpoint with its new secret

Media typeapplication/json
object
webhook_id
required
string
/^wh_[0-9a-f]{32}$/
url
required
string
description
required
string | null
events
required
Array<string>
Allowed values: * backtest.completed backtest.failed policy.activated policy.archived
status
required
string
Allowed values: enabled disabled
disabled_reason
required
string | null
failing_since
required

When deliveries started failing. The endpoint is disabled after three days of failures.

string | null format: date-time
environment
required
string
Allowed values: live test
previous_secret_expires_at

Set after a rotation while the old secret still signs deliveries.

string | null format: date-time
created_at
required
string format: date-time
updated_at
required
string format: date-time
secret
required

Signing secret. Shown only once.

string
/^whsec_[A-Za-z0-9_-]{43}$/

Example 

{
  "events": [
    "*"
  ],
  "status": "enabled",
  "environment": "live"
}

403

Section titled “403”

Missing scope or role, IP not allowed, or monthly quota exceeded (quota_exceeded).

Media typeapplication/json
object
error_code
required

Invalid_request, unauthorized, key_expired, key_revoked, forbidden, ip_not_allowed, quota_exceeded, not_found, method_not_allowed, conflict, policy_in_use, policy_active, policy_archived, idempotency_key_reused, validation_failed, rule_not_available, backtest_invalid_rows, backtest_too_large, rate_limited, internal_error

string
message
required
string
retryable
required
boolean
request_id
string
details
One of:
Array<object>
object
field
required
string
message
required
string
code
string

Example generated

{
  "error_code": "example",
  "message": "example",
  "retryable": true,
  "request_id": "example",
  "details": {}
}

404

Section titled “404”

Resource or endpoint not found.

Media typeapplication/json
object
error_code
required

Invalid_request, unauthorized, key_expired, key_revoked, forbidden, ip_not_allowed, quota_exceeded, not_found, method_not_allowed, conflict, policy_in_use, policy_active, policy_archived, idempotency_key_reused, validation_failed, rule_not_available, backtest_invalid_rows, backtest_too_large, rate_limited, internal_error

string
message
required
string
retryable
required
boolean
request_id
string
details
One of:
Array<object>
object
field
required
string
message
required
string
code
string

Example generated

{
  "error_code": "example",
  "message": "example",
  "retryable": true,
  "request_id": "example",
  "details": {}
}