Skip to main content
Alerting & Response/Alert Channels & Integrations

CreateAlertWebhookEndpoint

Create a new webhook endpoint with optional HMAC signing

POST/api/v1/alerting/webhook-endpoints

Operation ID

CreateAlertWebhookEndpoint

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

application/json

Body Fields

  • name
    StringRequired

    Human-readable name for the endpoint

    Example: Slack Webhook

  • url
    StringRequired

    Target URL for webhook delivery

    Example: https://hooks.slack.com/services/T00/B00/xxx

  • signingEnabled
    BooleanRequired

    Whether to enable HMAC signing

    Example: true

  • signingSecret
    StringRequired

    Initial signing secret (auto-generated if empty)

    Example: my-secret-key

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • endpoint
    Object

    Created webhook endpoint details

    • id
      String

      Unique identifier of the webhook endpoint

      Example: wh-001

    • name
      String

      Human-readable name for the endpoint

      Example: Slack Webhook

    • url
      String

      Target URL for webhook delivery

      Example: https://hooks.slack.com/services/T00/B00/xxx

    • signingEnabled
      Boolean

      Whether HMAC signing is enabled for this endpoint

      Example: true

    • signingSecretMasked
      String

      Masked signing secret (last 4 chars visible)

      Example: ****abc1

    • createdAt
      String

      Timestamp when the endpoint was created

      Example: 2026-01-15T08:00:00Z

    • updatedAt
      String

      Timestamp of the last endpoint update

      Example: 2026-01-15T08:00:00Z

  • signingSecretPlaintext
    String

    Plaintext signing secret (shown only once at creation)

    Example: whsec_abc123def456