Add Alert
Use this endpoint to add new alert settings record.
Webhooks
This section covers details around consuming InboxReady deliverability alerts via webhooks. If you are familiar with Mailgun 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:
- Encode the webhook’s entire POST request body with the HMAC algorithm (using your webhook signing key and SHA256 digest mode)
- Compare the resulting hexdigest to the signature provided in the POST request’s X-Sign header.
NOTE: If you’re consuming Mailgun webhooks, please note that your Mailgun webhook signing key differs from your InboxReady alerts webhook signing key. Your InboxReady alerts webhook signing key is available within the InboxReady 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.
Request Body schema: application/jsonoptional
A 200 response
Response Schema: application/json
A 400 response
A 409 response
A default response
- Payload
- curl
- Go
- Node.js
- PHP
- Java
- Python
- C#
{- "event_type": "ip_listed",
- "channel": "webhook",
}- 200
- 400
- 409
- default
{- "channel": "webhook",
- "id": "00000000-0000-0000-0000-000000000000",
- "event_type": "ip_listed"
}Update Alert
Use this endpoint to update an existing alert setting record.
NOTE: When updating a webhook alert, we will ensure the endpoint is reachable by sending a GET request to the provided URL. If a 200 response is not returned, a 400 will be returned and the alert setting update will be rejected.
Request Body schema: application/jsonoptional
- Payload
- curl
- Go
- Node.js
- PHP
- Java
- Python
- C#
{- "channel": "email",
- "settings": {
- "emails": [
- "recipient-a@example.com",
- "recipient-b@example.com"
]
}, - "event_type": "ip_delisted"
}- 200
- 400
- 404
- default
{- "message": "settings updated"
}List Alerts
This endpoint returns a list of all configured alert settings for your account.
A 200 response
Response Schema: application/json
required | Array of objects |
required | object |
required | object |
A default response
- curl
- Go
- Node.js
- PHP
- Java
- Python
- C#
- 200
- default
{- "events": [
- {
- "channel": "webhook",
- "event_type": "ip_listed",
- "id": "00000000-0000-0000-0000-000000000000",
}, - {
- "channel": "webhook",
- "disabled_at": "2006-01-02 22:04:05 +0000 UTC",
- "event_type": "ip_delisted",
- "id": "00000000-0000-0000-0000-000000000000",
}, - {
- "channel": "email",
- "event_type": "ip_delisted",
- "id": "00000000-0000-0000-0000-000000000000",
- "settings": {
- "emails": [
- "recipient-1@example.com",
- "recipient-2@example.com"
]
}
}
]
}- Payload
- curl
- Go
- Node.js
- PHP
- Java
- Python
- C#
{- "emails": [
- "email1@example.com",
- "email2@example.com"
], - "event_type": "some-event"
}- 200
- 400
{- "message": "string"
}