# Add Alert

Use this endpoint to add new alert settings record.

### Webhooks

This section covers details around consuming Mailgun Optimize alerts via webhooks. If you are familiar with Mailgun Send webhooks, 
there is a lot of overlapping similarity, however, there are also a few minor nuances to account for.

#### Securing Webhooks

HMAC is used to verified to integrity as well as the authenticity of received webhooks. To verify the origin of a webhook:

1. Encode the webhook’s entire POST request body with the HMAC algorithm (using your webhook signing key and SHA256 digest mode)
2. Compare the resulting hexdigest to the signature provided in the POST request’s X-Sign header.

NOTE: If you’re consuming Mailgun Send webhooks, please note that your Mailgun Send webhook signing key differs 
from your Mailgun Optimize alerts webhook signing key. 
Your Mailgun Optimize alerts webhook signing key is available within the Mailgun Optimize UI.

#### Webhook URL Validation

When adding or updating a webhook URL for alerts, we will ensure the endpoint is reachable by sending a GET request to the provided URL. If a 200 response is not returned from your endpoint, the request will be rejected and your alert setting will not be saved. We intentionally chose to send a GET request instead of a POST when validating URLs so that your webhook endpoint does not have to account for test requests.

Additionally, when a POST request is sent to your webhook URL, if a 2xx is not returned, we will attempt retries via an exponential backoff strategy for up to ~8 hours. If the max retry count is reached, the alert will be disabled and the related alert settings record’s disabled_at field will be populated.

Endpoint: POST /v1/alerts/settings/events
Version: 0.0.1
Security: basicAuth

## Request fields (application/json):

  - `event_type` (string, required)
    The type of event for which you would like to receive alerts.

  - `channel` (object, required)
    The delivery method for the alert.

  - `settings` (object, required)
    The details pertaining to the specified channel. Please note that the contents of this object differ per channel type.

  - `settings.url` (string)
    For webhook channel.

  - `settings.emails` (array)
    For email channel

  - `settings.channel_ids` (array)
    For slack channel

## Response 200 fields (application/json):

  - `id` (string)
    The unique identifier for the alert settings record.

  - `event_type` (string, required)
    The event type that is alerted on. Check GET /v1/alerts/events for possible values.

  - `channel` (object, required)
    The delivery channel for the alert.

  - `settings` (object, required)
    This object contains channel-specific settings.

  - `settings.url` (string)
    For webhook channel.

  - `settings.emails` (array)
    For email channel

  - `settings.channel_ids` (array)
    For slack channel

  - `disabled_at` (string,null)
    Read only. When present

## Response 400 fields (application/json):

  - `message` (string, required)
    Response message

## Response 409 fields (application/json):

  - `message` (string, required)
    Response message

## Response default fields (application/json):

  - `message` (string, required)
    Response message