Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lucid.foundation/llms.txt

Use this file to discover all available pages before exploring further.

Webhooks SDK

Deployment webhook receivers — normalizes provider-specific callbacks into deployment events

Operations

MethodDescription
lucidReceiveDeploymentWebhookReceive deployment webhook

Generated Reference

Overview

Deployment webhook receivers — normalizes provider-specific callbacks into deployment events

Available Operations

lucidReceiveDeploymentWebhook

Receive and normalize provider-specific deployment webhooks (Railway, Akash, Phala, io.net, Nosana). The provider path parameter selects the appropriate normalizer. Webhook payloads are converted into deployment events.

Example Usage

import { RaijinLabsLucidAi } from "raijin-labs-lucid-ai";

const raijinLabsLucidAi = new RaijinLabsLucidAi();

async function run() {
  const result = await raijinLabsLucidAi.webhooks.lucidReceiveDeploymentWebhook({
    provider: "railway",
    body: {
      "key": "<value>",
      "key1": "<value>",
    },
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:
import { RaijinLabsLucidAiCore } from "raijin-labs-lucid-ai/core.js";
import { webhooksLucidReceiveDeploymentWebhook } from "raijin-labs-lucid-ai/funcs/webhooksLucidReceiveDeploymentWebhook.js";

// Use `RaijinLabsLucidAiCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const raijinLabsLucidAi = new RaijinLabsLucidAiCore();

async function run() {
  const res = await webhooksLucidReceiveDeploymentWebhook(raijinLabsLucidAi, {
    provider: "railway",
    body: {
      "key": "<value>",
      "key1": "<value>",
    },
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("webhooksLucidReceiveDeploymentWebhook failed:", res.error);
  }
}

run();

Parameters

ParameterTypeRequiredDescription
requestoperations.LucidReceiveDeploymentWebhookRequest:heavy_check_mark:The request object to use for the request.
optionsRequestOptions:heavy_minus_sign:Used to set various options for making HTTP requests.
options.fetchOptionsRequestInit:heavy_minus_sign:Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retriesRetryConfig:heavy_minus_sign:Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.LucidReceiveDeploymentWebhookResponse>

Errors

Error TypeStatus CodeContent Type
errors.ErrorResponse400application/json
errors.ErrorResponse500application/json
errors.RaijinLabsLucidAiDefaultError4XX, 5XX*/*