Skip to main content
Version: v1

invoke()

Invokes a Supabase Function.

const { data: user, error } = await supabase.functions.invoke('hello', {
body: JSON.stringify({ foo: 'bar' })
})

Parameters

  • functionNamerequiredstring

    the name of the function to invoke

  • invokeOptionsoptionalFunctionInvokeOptions

    object with the following properties headers: object representing the headers to send with the request body: the body of the request responseType: how the response should be parsed. The default is json

Notes

  • Requires an Authorization header.
  • Invoke params generally match the Fetch API spec.

Examples

Basic invocation.

const { data: user, error } = await supabase.functions.invoke('hello', {
body: JSON.stringify({ foo: 'bar' })
})

Specifying response type.

By default, invoke() will parse the response as JSON. You can parse the response in the following formats: json, blob, text, and arrayBuffer.

const { data: user, error } = await supabase.functions.invoke('hello', {
responseType: 'text',
body: JSON.stringify({ foo: 'bar' })
})

Parsing custom headers.

You can pass custom headers to your function. Note: supabase-js automatically passes the Authorization header with the signed in user's JWT.

const { data: user, error } = await supabase.functions.invoke('hello', {
headers: {
"my-custom-header": 'my-custom-header-value'
},
body: JSON.stringify({ foo: 'bar' })
})