AddWebhookNotification to call Method in Controller

Question

I have this configured in my StartUp.cs:

    public void ConfigureServices(IServiceCollection services)
    {
        services
            .ConfigureEmail(Configuration)
            .AddHealthChecksUI(setupSettings: setup =>
            {
                setup
                    .AddWebhookNotification("WebHookTest", "/WebhookNotificationError",
                        "{ message: \"Webhook report for [[LIVENESS]]: [[FAILURE]] - Description: [[DESCRIPTIONS]]\"}",
                        "{ message: \"[[LIVENESS]] is back to life\"}",
                        customMessageFunc: report =>
                        {
                            var failing = report.Entries.Where(e => e.Value.Status == UIHealthStatus.Unhealthy);
                            return $"{failing.Count()} healthchecks are failing";
                        },
                        customDescriptionFunc: report =>
                        {
                            var failing = report.Entries.Where(e => e.Value.Status == UIHealthStatus.Unhealthy);
                            return $"HealthChecks with names {string.Join("/", failing.Select(f => f.Key))} are failing";
                        });
            })
            .AddControllers();
    }

    public void Configure(IApplicationBuilder app)
    {
        var pathBase = Configuration["PATH_BASE"];
        if (!string.IsNullOrEmpty(pathBase))
        {
            app.UsePathBase(pathBase);
        }
    
        app.ConfigureExceptionHandler();
        app
            .UseRouting()
            .UseEndpoints(endpoints =>
            {
                endpoints.MapHealthChecksUI(options =>
                {
                    options.ResourcesPath = string.IsNullOrEmpty(pathBase) ? "/ui/resources" : $"{pathBase}/ui/resources";
                    options.UIPath = "/hc-ui";
                    options.ApiPath = "/api-ui";
                });
                endpoints.MapDefaultControllerRoute();
            });
    }

And in the Controller:

    [HttpPost]
    [Consumes(MediaTypeNames.Application.Json)]
    public async Task<IActionResult> WebhookNotificationError([FromBody] string id)
    {
        MimeMessage mimeMessage = new MimeMessage { Priority = MessagePriority.Urgent };
        mimeMessage.To.Add(new MailboxAddress(_configuration.GetValue<string>("ConfiguracionCorreoBase:ToEmail")));
        mimeMessage.Subject = "WebHook Error";
        BodyBuilder builder = new BodyBuilder { HtmlBody = id };
        mimeMessage.Body = builder.ToMessageBody();
        await _appEmailService.SendAsync(mimeMessage);
        return Ok();
    }

The watchdog application is configured in the appSettings.json to listen to different APIs. So far everything works fine, but, if I force an error, I'd like to receive a notification email. The idea is that, when an error occurs in any of the Healths, you send an email.

Environment:

.NET Core version: 3.1
Healthchecks version: AspNetCore.HealthChecks.UI 3.1.0
Operative system: Windows 10

score 1 · Answer 1 · answered Jul 16 '20 at 21:51

It's look like you problem in routes. Did you verify that method with Postman? Also check if your webHook request body is a text, try to change your template payload:

{ "message": "Webhook report for [[LIVENESS]]: [[FAILURE]] - Description: [[DESCRIPTIONS]]"}",

and in the controller change string to object. And check what you receive in DEBUG.

score 0 · Answer 2 · answered Oct 01 '20 at 10:26

0

Try using Api/WebhookNotificationError inst. of /WebhookNotificationError if your controller is ApiController. The controller name seems to be missing

answered Oct 01 '20 at 10:26

procma

1,174
3
14
24

score 0 · Answer 3 · answered Apr 08 '22 at 01:40

I think you should try this. It works for me.

[HttpPost]
[Consumes(MediaTypeNames.Application.Json)]
public async Task<IActionResult> WebhookNotificationError()
{
    using (var reader = new StreamReader(
        Request.Body,
        encoding: Encoding.UTF8,
        detectEncodingFromByteOrderMarks: false))
    {
        var payload = await reader.ReadToEndAsync();

        //do whatever with your payloade here..
        //I am just returning back for a example.
        return Ok(payload);
    }
}

AddWebhookNotification to call Method in Controller

3 Answers3