Forward a call to a webhook

Create a proxy function so an external endpoint is reachable through the same interface as your other functions.

Prerequisites

• An app, and its slug.
• A webhook URL that accepts a JSON POST.
• Any credentials that endpoint requires.

Create the function

Set execution_mode to proxy and provide webhook_url. Proxy functions carry no code.

TaruviBase Console

1. Open the app and select Functions.
2. Select Create Function, then choose the PROXY execution mode.
3. Enter the webhook URL, then configure authentication and headers.
4. Save.

REST API

Create the function with execution_mode set to proxy and a webhook_url field. The request otherwise matches creating an app function.

Proxy functions are not available in the JavaScript or Python SDKs.

Understand what gets sent

Executing a proxy function sends a POST with a JSON body of this shape:

{
  "params": {"order_id": 123, "request": {}},
  "user": {"id": "USER_ID", "username": "USER_NAME", "email": "USER_EMAIL"}
}

params carries the caller's parameters plus HTTP request metadata. user describes the authenticated caller.

The request always uses POST and always sends JSON, whichever verb the caller used to invoke the function.

Configure authentication

Four styles are available through auth_config.

Type	Fields	Sends
bearer	token	Authorization: Bearer <token>
api_key	key_value, optional key_name	The key in the named header, X-API-Key by default
basic	username, password	An encoded Authorization: Basic header
custom	headers	Each header exactly as supplied

Add any further headers through the function's headers field.

warning

Credentials in auth_config are stored on the function record, and any organization user with access to the site can read and change that record. Use a credential scoped narrowly to this integration, and rotate it if your organization's members change.

Set the timeout

Proxy requests time out after 30 seconds. Override that per function through config.timeout, in seconds:

{"config": {"timeout": 10}}

Keep it well below the synchronous execution wait so a caller receives a clear proxy error rather than a stalled request.

Read the response

A proxy function returns the webhook's status_code, its parsed body under response, and its headers. success is true for any 2xx status.

A non-2xx response is returned rather than raised, so check status_code rather than assuming a result means success. A timeout, connection failure, or unparsable response fails the execution instead.

Point it only at endpoints you trust

A proxy function forwards to whatever URL it is configured with, so point one only at an endpoint you control or otherwise trust.

Saving a proxy function does not contact the webhook, so a destination that is wrong or unreachable surfaces on the first run rather than at save time.

warning

Anyone who can edit a function in the site can change its webhook_url and auth_config, redirecting the call and its credentials to another destination. Review proxy functions when your organization's members change.

See Security and limits.

Verify

Execute the function and confirm the webhook received the request and the response came back intact. The invocation record stores the status code and body returned by the webhook, not what the remote system did with the call — check that system's own logs when a result is unexpected.

Related

• Execution modes
• Execute a function
• Security and limits