Display localized error messages from webhooks

[glen-84]

Display localized error messages from webhooks

Problem

When webhooks fail, a generic error message is displayed, which is not at all useful to an end user. I suggest allowing webhooks to return an error message to be displayed (see also #1696).

Solution

For example (in response to a failed webhook):

{
    "error": {
        "code": "abc123", // optional code
        "message": "Show this message in the UI.", // optional non-localized message
        "messageId": "access-denied", // look up localized message, and optionally fall back to "message" (when present)
        "context": "..." // optional additional context (stack trace, etc.) to be logged
    }
}

(this will obviously not work when the network request fails entirely)

Alternatives/workarounds

I don't think that there are any.

Additional context

#814 (comment)
#814 (comment)

Related

• Webhook Status Code Definitions #814
• Throwing Exception within Lambda Exits Login Flow #1707

Community guidelines

All issues filed in this repository must abide by the FusionAuth community guidelines.

How to vote

Please give us a thumbs up or thumbs down as a reaction to help us prioritize this feature. Feel free to comment if you have a particular need or comment on how this feature should work.

[robotdan]

Would one of the solutions outlined here work?

• Customize message that a webhook failed during login #757
• Unable to customize WebhookTransactionException message during login #1446

Or are you looking for something else?

[glen-84]

I'm aware of that option, but it's only one string. The idea here is to be able to return messages (or message IDs) for different types of issues in different webhooks, to be displayed in the hosted UI and the admin panel.

The more general idea of returning data is also part of #1696.

[cch99]

Any updates to this issue? I'm looking for this feature to verify email address before registration. I need to be able to return a custom error message based on a lookup from a database.

[mooreds]

@cch99 this work is not currently planned. Here's our general roadmap guidance: https://fusionauth.io/docs/v1/tech/core-concepts/roadmap