Chenxin_Yan•2mo ago

HTTP Actions the best way to validate request body

I am using HTTP Actions and the request param is unknown. There is no documented way to validate request or how to use built-in validator to validate object shape inside of actions. I am wondering what is the best way to handle this.

7 Replies

Convex Bot•2mo ago

Thanks for posting in <#1088161997662724167>. Reminder: If you have a Convex Pro account, use the Convex Dashboard to file support tickets. - Provide context: What are you trying to achieve, what is the end-user interaction, what are you seeing? (full error message, command output, etc.) - Use search.convex.dev to search Docs, Stack, and Discord all at once. - Additionally, you can post your questions in the Convex Community's <#1228095053885476985> channel to receive a response from AI. - Avoid tagging staff unless specifically instructed. Thank you!

Clever Tagline•2mo ago

Please share an example from your code. The HTTP action function should look something like:

import { httpAction } from "./_generated/server"

const myAction = httpAction (async (ctx, request) => {
  // request is available in here
})

import { httpAction } from "./_generated/server"

const myAction = httpAction (async (ctx, request) => {
  // request is available in here
})

Chenxin_YanOP•2mo ago

yes, given this action when I have const body = await request.json() , body is undefined how could I validate it using convex validator? or do i need to create zod schemas sepoerately and use zod to validate?

Clever Tagline•2mo ago

There's still a lot that you haven't shared about your actual setup, and without that it's tough to know what's happening. Could you please share code snippets of the relevant pieces? E.g. the httpAction function definition, the http.route definition that targets that function, and even an example request to the endpoint.

Chenxin_YanOP•2mo ago

Take this snippet:

http.route({
  path: "/api/requirements/create",
  method: "POST",
  handler: httpAction(async (ctx, request) => {
    const result = await request.json();

    return new Response(JSON.stringify({ success: true }), {
      status: 200,
      headers: { "Content-Type": "application/json" },
    });
  }),
});

http.route({
  path: "/api/requirements/create",
  method: "POST",
  handler: httpAction(async (ctx, request) => {
    const result = await request.json();

    return new Response(JSON.stringify({ success: true }), {
      status: 200,
      headers: { "Content-Type": "application/json" },
    });
  }),
});

With this setup is there a way to validate the request body with convex without relying on something like zod? such as use convex built-in validator?

Chenxin_YanOP•2mo ago

observe that result is unknown

Clever Tagline•2mo ago

That's really odd that the request isn't being typed correctly. I've never seen this issue. When you hover over httpAction what does it show? As for using the built-in Convex validator, that only works with Convex functions as far as I know, plus it's only a Typescript validator. To validate the data coming in via an HTTP request, you'll need to use Zod or something similar that validates the data at runtime.

HTTP Actions the best way to validate request body

Did you find this page helpful?