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

ReceiveAlertmanagerWebhook

Receive alert notifications from Alertmanager webhook callbacks Auth: X-Webhook-Secret header (static secret, forwarded as gRPC metadata).

Execution Availability

Try It Out

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

Path Parameters

Request Inputs

Path Parameters

  • receiverStringRequired

    Receiver name from Alertmanager configuration

Body Fields

  • versionStringRequired

    Alertmanager API version

    Example: 4

  • groupKeyStringRequired

    Group key identifying the alert group

    Example: {}:{alertname=HighCPU}

  • truncatedAlertsIntegerRequired

    Number of alerts truncated from the payload

    Example: 20

  • statusStringRequired

    Group status: firing or resolved

    Example: firing

  • externalUrlStringRequired

    External URL of the Alertmanager instance

    Example: http://alertmanager:9093

Responses

200 OK

On success, this API returns the following response structure.

  • receivedInteger

    Number of alerts received in the payload

    Example: 5

  • createdInteger

    Number of new alerts created

    Example: 3

  • updatedInteger

    Number of existing alerts updated

    Example: 1

  • skippedInteger

    Number of duplicate alerts skipped

    Example: 1

  • injectedInteger

    Number of alerts injected into the pipeline

    Example: 4

  • fallbackBoolean

    Whether fallback processing was used

    Example: false

  • fallbackReasonString

    Reason for fallback if applicable

    Example: primary channel unavailable

Endpoint

POST/api/v1/alerting/webhook/{receiver}

/api/v1/alerting/webhook/{receiver}

Operation ID

ReceiveAlertmanagerWebhook

Permalink

Request Example

curl -X POST '{host}/api/v1/alerting/webhook/{receiver}' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"version":"4","groupKey":"{}:{alertname=HighCPU}","truncatedAlerts":20,"status":"firing","externalUrl":"http://alertmanager:9093","groupLabels":"(nested object)","commonLabels":"(nested object)","commonAnnotations":"(nested object)","alerts":"(nested array)"}'

Response Example

200
{
  "received": 5,
  "created": 3,
  "updated": 1,
  "skipped": 1,
  "injected": 4,
  "fallback": false,
  "fallbackReason": "primary channel unavailable"
}

Change History

This API has no change history records yet.

View all change history