Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Routing & Policies
GETAlertingSince 1.0SynchronousAuth Required

GetAlertWebhookSecurityDocs

Retrieve webhook security documentation including signing algorithm details

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Request Inputs

This API requires no request parameters.

Responses

200 OK

On success, this API returns the following response structure.

  • algorithmString

    HMAC algorithm used for signing

    Example: HMAC-SHA256

  • signatureFormatString

    Format of the signature header value

    Example: v1=<hex-digest>

  • headerTimestampString

    HTTP header name for the timestamp

    Example: X-Webhook-Timestamp

  • headerSignatureString

    HTTP header name for the signature

    Example: X-Webhook-Signature

  • payloadFormatString

    Format of the signed payload

    Example: timestamp.body

  • replayWindowSecInteger

    Replay window in seconds for signature validation

    Example: 300

  • examplesLinkedHashMap

    Example entries for reference

    Example: (nested object)

Endpoint

GET/api/v1/alerting/docs/webhook-security

/api/v1/alerting/docs/webhook-security

Operation ID

GetAlertWebhookSecurityDocs

Permalink

Request Example

curl -X GET '{host}/api/v1/alerting/docs/webhook-security' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "algorithm": "HMAC-SHA256",
  "signatureFormat": "v1=<hex-digest>",
  "headerTimestamp": "X-Webhook-Timestamp",
  "headerSignature": "X-Webhook-Signature",
  "payloadFormat": "timestamp.body",
  "replayWindowSec": 300,
  "examples": null
}

Change History

This API has no change history records yet.

View all change history