docs/docs/actions/action-handlers.mdx
import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import Thumbnail from '@site/src/components/Thumbnail';
Actions need to be backed by custom business logic. This business logic can be defined in a handler which is an HTTP webhook.
When the action is executed i.e. when the query or the mutation is called, Hasura makes a POST request to the handler
with the action arguments and the session variables.
The request payload is of the format:
{
"action": {
"name": "<action-name>"
},
"input": {
"arg1": "<value>",
"arg2": "<value>"
},
"session_variables": {
"x-hasura-user-id": "<session-user-id>",
"x-hasura-role": "<session-user-role>"
},
"request_query": "<request-query>"
}
:::info Note
All session_variables in the request payload have lowercase keys.
:::
To return a success response, you must send back a response payload of action's response type. The HTTP status code must
be 2xx for a successful response.
To return an error response, you must send back an error object. An error object looks like:
{
"message": "<mandatory-error-message>",
"extensions": "<optional-json-object>"
}
where extensions is an optional JSON value.
If present, extensions should be a JSON object, which may have a status code field code, along with other data you
may want to add to your errors:
{
"code": "<optional-error-code>",
"optionalField1": "<custom-data-here>"
}
The HTTP status code must be 4xx in order to indicate an error response.
For backwards compatibility with previous versions of Hasura, the code field may also be supplied at the root of the
error object, i.e. at $.code. This will be deprecated in a future release, and providing code within extensions is
preferred.
For example, consider the following mutation.
extend type Mutation {
UserLogin(username: String!, password: String!): UserInfo
}
type UserInfo {
accessToken: String!
userId: Int!
}
Let's say, the following mutation is executed:
mutation {
UserLogin(username: "jake", password: "secretpassword") {
accessToken
userId
}
}
Hasura will call the handler with the following payload:
{
"action": {
"name": "UserLogin"
},
"input": {
"username": "jake",
"password": "secretpassword"
},
"session_variables": {
"x-hasura-user-id": "423",
"x-hasura-role": "user"
},
"request_query": "mutation {\n UserLogin (username: \"jake\", password: \"secretpassword\") {\n accessToken\n userId\n }\n}\n"
}
To return a success response, you must send the response of the action's output type (in this case, UserInfo) with a
status code 2xx. So a sample response would be:
{
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVC",
"userId": 423
}
To throw an error, you must send a response of the following type while setting the status code as 4xx.
{
"message": "invalid credentials"
}
You might want to restrict access to your action handler in order to ensure that it can only get called by your Hasura instance and not by third parties.
One possible way of restricting access to an action handler is by adding a header to the action that is automatically sent with each request to the webhook, and then adding a check against that in your action handler.
:::info Note
Adding an action secret is a simple way of restricting access to an action handler and will suffice in most use cases. However, if you have more profound security requirements, you might want to choose advanced security solutions tailored to your needs.
:::
In your Hasura server, add the action secret as an environment variable, say ACTION_SECRET_ENV.
For your action, add a header that will act as an action secret.
<Tabs groupId="user-preference" className="api-tabs"> <TabItem value="console" label="Console">Head to the Actions -> [action-name] tab in the Console and scroll down to Headers. You can now configure an action
secret by adding a header:
Then hit Save.
Go to metadata/actions.yaml in the Hasura Project directory.
Update the definition of your action by adding the action secret as a header:
- actions
- name: actionName
definition:
kind: synchronous
handler: http://localhost:3000
forward_client_headers: true
headers:
- name: ACTION_SECRET
value_from_env: ACTION_SECRET_ENV
Save the changes and run hasura metadata apply to set the headers.
Headers can be set when creating or updating an action via the Metadata API.
POST /v1/metadata HTTP/1.1
Content-Type: application/json
X-Hasura-Role: admin
{
"type": "create_action",
"args": {
"name": "addNumbers",
"definition": {
"kind": "synchronous",
"type": "query",
"headers": [
{
"name": "ACTION_SECRET",
"value_from_env": "ACTION_SECRET_ENV"
}
],
"arguments": [
{
"name": "numbers",
"type": "[Int]!"
}
],
"output_type": "AddResult",
"handler": "https://hasura-actions-demo.glitch.me/addNumbers"
}
}
}
:::info Note
In case there are multiple headers with the same name, the order of precedence is: client headers > resolved user
(x-hasura-*) variables > configuration headers.
If you want to change the order of precedence to: configuration headers > resolved user (x-hasura-*) variables >
client headers, use the
configured header precedence flag or
environment variable.
:::
:::info Note
Before creating an action via the create_action Metadata API, all custom types need to be defined via the set_custom_types Metadata API.
:::
This secret is only known by Hasura and is passed to your endpoint with every call, thus making sure only Hasura can successfully authenticate with the action handler.
:::info Header names
The name for the action secret is not defined by Hasura and can be chosen freely. If you're utilizing nginx, take care to enable underscores in headers if you choose to use them in your header keys.
:::
First, load the action secret as an environment variable in your action handler by adding it to your .env file (this
file might be a different one depending on your framework).
Second, you need to write some code in your action handler to check that the action secret passed as a header equals to the one you stored as an environment variable.
The following is an example of a simple authorization middleware with Express which can be included before the request handler logic:
// use authorization for all routes
app.use(authorizationMiddleware);
// authorize action call
function authorizationMiddleware(req, res, next) {
if (correctSecretProvided(req)) next();
else res.sendStatus(403);
}
// check if the secret sent in the header equals to the secret stored as an env variable
function correctSecretProvided(req) {
const requiredSecret = process.env.ACTION_SECRET_ENV;
const providedSecret = req.headers['ACTION_SECRET'];
return requiredSecret === providedSecret;
}
// Request handler
app.post('/actionHandler', async (req, res) => {
// handler logic
});
:::info Additional Resources
Introduction to Hasura Actions - View Recording.
:::