> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# fal webhooks

> fal incoming webhooks in Corsair: the event paths to subscribe to, the payload each event carries, and the response data.

The fal plugin handles incoming webhooks. Point your provider’s subscription URL at your Corsair HTTP handler (see [Overview](https://docs.corsair.dev/plugins/fal/overview.md) for setup context and the exact URL shape).

> [!NOTE]
>
> **New to Corsair?** See [webhooks](https://docs.corsair.dev/concepts/webhooks.md) and [hooks](https://docs.corsair.dev/concepts/hooks.md).

## Webhook map

* `requests`
  * `completed` (`requests.completed`)

## HTTP handler setup

```ts app/api/webhook/route.ts theme={null}
import { processWebhook } from "corsair";
import { corsair } from "@/server/corsair";

export async function POST(request: Request) {
    const headers = Object.fromEntries(request.headers);
    // With multiTenancy, give each tenant its own URL (/api/webhook?tenantId=acme):
    // the query says whose account, secret and hooks handle the delivery.
    const query = Object.fromEntries(new URL(request.url).searchParams);
    // The raw text, not request.json(): signatures are checked over the exact bytes sent.
    const body = await request.text();
    const result = await processWebhook(corsair, headers, body, query);
    if (!result.plugin) {
        return Response.json({ success: false }, { status: 404 });
    }
    // A refusal (bad signature) carries no status and answers 400; a handler
    // that threw comes back with 500, so the sender retries it.
    const status =
        result.response?.success === false ? (result.response.statusCode ?? 400) : 200;
    return Response.json(result.response ?? { success: true }, {
        status,
        headers: result.responseHeaders,
    });
}
```

## Events

## Requests

### Completed

`requests.completed`

A queued request finished: status OK with the model output, or ERROR with the error. Signed by fal (Ed25519).

**Payload**

| Name | Type | Required | Description |
| - | - | - | - |
| `request_id` | `string` | Yes | — |
| `gateway_request_id` | `string \| null` | No | The last attempt’s id; differs from request\_id when fal retried. |
| `status` | `OK \| ERROR` | Yes | OK: payload is the model output. ERROR: payload is the error body. |
| `payload` | `Record<string, any> \| null` | Yes | — |
| `error` | `string \| null` | No | — |
| `payload_error` | `string \| null` | No | Set when fal could not include the output; read it with queue.result. |

> [accordion] Response data full type
>
> ```ts theme={null}
> {
>   request_id: string,
>   gateway_request_id?: string | null,
>   status: OK | ERROR,
>   payload: Record<string, any> | null,
>   error?: string | null,
>   payload_error?: string | null
> }
> ```

**`webhookHooks` example**

```ts theme={null}
fal({
    webhookHooks: {
        requests: {
            completed: {
                before(ctx, args) {
                    return { ctx, args };
                },
                after(ctx, response) {
                },
            },
        },
    },
})
```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.