System Webhooks
Appmixer Engine Events.
Components might throw exceptions. Such exceptions/errors are logged and user can see them in the Insights. However, you might want to implement your custom logic or notification system for when this occurs. You may want to notify your users or handle/log the errors in a totally custom way.
If you want to listen for component errors you can set the
WEBHOOK_FLOW_COMPONENT_ERROR environment variable to a URL that the Appmixer engine will send an HTTP POST request to whenever an error occurs. It can you any external (but accessible) URL or you can even create a flow in Appmixer and point this URL to a Webhook component to handle these errors using Appmixer itself (e.g. by sending an email, Slack notification, ...).Set the
WEBHOOK_FLOW_COMPONENT_ERROR variable in docker-compose.yml file: engine:
build:
context: .
dockerfile: Dockerfile
depends_on:
- mongodb
- rabbitmq
- elasticsearch
- redis
environment:
# this variable has to point to your Webhook
- WEBHOOK_FLOW_COMPONENT_ERROR=https://your.example.com/error-handling-url
Example of an error POSTed to your URL (a validation error in this case):
{
"err": {
"message": "Validation error on ports: in",
"error": {
"in": [
[
{
"keyword": "format",
"dataPath": ".to",
"schemaPath": "#/properties/to/format",
"params": {
"format": "email"
},
"message": "should match format \"email\""
}
]
]
},
"code": "GRID_ERR_VAL_PORTS",
"name": "ValidationFlowError",
"stack": "ValidationFlowError: Validation error on ports: in\n at MessagesProcessor.process (/Users/martinkrcmar/Programming/client/appmixer/appmixer-core/engine/src/context/MessagesProcessor.js:67:19)\n at Context.prepare (/Users/martinkrcmar/Programming/client/appmixer/appmixer-core/engine/src/context/Context.js:68:31)\n at ContextHandler.createContext (/Users/martinkrcmar/Programming/client/appmixer/appmixer-core/engine/src/context/ContextHandler.js:60:17)\n at async InputQueue.consume (/Users/martinkrcmar/Programming/client/appmixer/appmixer-core/engine/src/InputQueue.js:151:23)\n at async InputQueue.onMessage (/Users/martinkrcmar/Programming/client/appmixer/appmixer-core/engine/src/AMQPClient.js:378:20)"
},
"flowId": "32f605b2-8fbe-4f68-9db9-ce182b35c159",
"flowName": "New flow",
"userId": "5f804b96ea48ec47a8c444a7",
"componentId": "0bb33e42-fbc4-464e-98f1-459f1ff626ac",
"componentType": "appmixer.utils.email.SendEmail",
"inputMessages": {
"in": [
{
"properties": {
"correlationId": "339bc448-a806-4e61-8d38-4211fcedaf12",
"gridInstanceId": null,
"contentType": "application/json",
"contentEncoding": "utf8",
"sender": {
"componentId": "e8c581b4-9985-4f2c-bf30-895bf1d5541b",
"type": "appmixer.utils.controls.OnStart",
"outputPort": "out"
},
"destination": {
"componentId": "0bb33e42-fbc4-464e-98f1-459f1ff626ac",
"inputPort": "in"
},
"correlationInPort": null,
"componentHeaders": {},
"flowId": "32f605b2-8fbe-4f68-9db9-ce182b35c159",
"messageId": "47293e2c-4e33-4558-8805-386de392ef04",
"flowRunId": 1607683798995
},
"content": {
"to": "2020-12-11T10:49:59.050Z"
},
"scope": {
"e8c581b4-9985-4f2c-bf30-895bf1d5541b": {
"out": {
"started": "2020-12-11T10:49:59.050Z"
}
}
},
"originalContent": {
"started": "2020-12-11T10:49:59.050Z"
}
}
]
},
"accessTokenId": null
}
This error was triggered in a sample flow that looks like this:
The email address in the "To" configuration field of the SendEmail component points to a variable from the OnStart component. Its value is dynamic, it is only known during runtime. Therefore the user is allowed to start such a flow, but it will fail at runtime. Start time variable contains a date string, but the SendEmail address requires a valid email address in the To input field. The error will be logged and seen in the log viewer.
Log viewer in Designer.
Consider the flow is configured correctly this time and the email address is valid. But there is a network error and Appmixer cannot send the email.
This error will be logged and the user will be able to see it in the log viewer or in the Insights. And the JSON representing this error will look like this:
{
"err": {
"stack": "Error: getaddrinfo ENOTFOUND mandrillapp.com\n at GetAddrInfoReqWrap.onlookup [as oncomplete] (dns.js:66:26)",
"message": "getaddrinfo ENOTFOUND mandrillapp.com",
"errno": "ENOTFOUND",
"code": "ENOTFOUND",
"syscall": "getaddrinfo",
"hostname": "mandrillapp.com",
"name": "Error"
},
"flowId": "0ab287ef-7bd6-4cc3-b53b-c916c857cbe7",
"flowName": "Invalid email test",
"userId": "5fd744d5e9ed7d0011ca35f9",
"componentId": "cb3f4ff5-7b6e-4d24-b7a8-2115c8254baa",
"componentType": "appmixer.utils.email.SendEmail",
"inputMessages": {
"in": [
{
"properties": {
"correlationId": "254ad628-f9c1-4483-81ed-33a22ac3ddc6",
"gridInstanceId": null,
"contentType": "application/json",
"contentEncoding": "utf8",
"sender": {
"componentId": "bcbeda1d-9036-45af-a25d-a57cf06e3f90",
"type": "appmixer.utils.controls.OnStart",
"outputPort": "out"
},
"destination": {
"componentId": "cb3f4ff5-7b6e-4d24-b7a8-2115c8254baa",
"inputPort": "in"
},
"correlationInPort": null,
"componentHeaders": {},
"flowId": "0ab287ef-7bd6-4cc3-b53b-c916c857cbe7",
"messageId": "33b9fcbf-b326-4eb4-bba6-cf34979f4ba2",
"flowRunId": 1607944841843,
"quotaId": "qs-4882d03d-65e1-44dc-983e-d2a33071779d"
},
"content": {
"to": [
{
"email": "[email protected]",
"type": "to"
}
],
"from_email": "[email protected]"
},
"scope": {
"bcbeda1d-9036-45af-a25d-a57cf06e3f90": {
"out": {
"started": "2020-12-14T11:20:41.858Z"
}
}
},
"originalContent": {
"started": "2020-12-14T11:20:41.858Z"
}
}
]
},
"accessTokenId": null
}