Skip to main content
API Explorer|API Explorer
Alerting & Response/Alert Channels & Integrations
POSTAlertingSince 1.0SynchronousAuth Required

CreateAlertWebhookEndpoint

Create a new webhook endpoint with optional HMAC signing

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • nameStringRequired

    Human-readable name for the endpoint

    Example: Slack Webhook

  • urlStringRequired

    Target URL for webhook delivery

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

  • signingEnabledBooleanRequired

    Whether to enable HMAC signing

    Example: true

  • signingSecretStringRequired

    Initial signing secret (auto-generated if empty)

    Example: my-secret-key

Responses

200 OK

On success, this API returns the following response structure.

  • endpointObject

    Created webhook endpoint details

    • idString

      Unique identifier of the webhook endpoint

      Example: wh-001

    • nameString

      Human-readable name for the endpoint

      Example: Slack Webhook

    • urlString

      Target URL for webhook delivery

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

    • signingEnabledBoolean

      Whether HMAC signing is enabled for this endpoint

      Example: true

    • signingSecretMaskedString

      Masked signing secret (last 4 chars visible)

      Example: ****abc1

    • createdAtString

      Timestamp when the endpoint was created

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

    • updatedAtString

      Timestamp of the last endpoint update

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

  • signingSecretPlaintextString

    Plaintext signing secret (shown only once at creation)

    Example: whsec_abc123def456

Endpoint

POST/api/v1/alerting/webhook-endpoints

/api/v1/alerting/webhook-endpoints

Operation ID

CreateAlertWebhookEndpoint

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/webhook-endpoints' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"name":"Slack Webhook","url":"https://hooks.slack.com/services/T00/B00/xxx","signingEnabled":true,"signingSecret":"my-secret-key"}'

Response Example

200
{
  "endpoint": {},
  "signingSecretPlaintext": "whsec_abc123def456"
}

Change History

This API has no change history records yet.

View all change history