Context

The ctx object is the second parameter of every handler. It contains info about the company, channel, user, trigger type, and provides access to secrets, messaging, memory, and logging.

handler: async (input, ctx, request) => {
  ctx.log("Request received", {
    company: ctx.company.name,
    bot: ctx.bot.channel,
    user: ctx.user.id,
    trigger: ctx.trigger.type,
  });
}

Reference

Property	Type	Description
`ctx.functionSlug`	`string`	Function slug
`ctx.company`	`{ id, name }`	Company of the request
`ctx.bot`	`{ id, name, channel }`	Channel that originated the request
`ctx.user`	`{ id, names?, roomId? }`	Conversation user
`ctx.conversation`	`{ id?, ... }`	Conversation data
`ctx.operator`	`{ id?, ... }`	Assigned operator
`ctx.trigger`	`TriggerInfo`	Trigger type (http, cron, event)
`ctx.env`	`EnvAccessor`	Access to secrets
`ctx.params`	`Record<string, string>`	Route parameters
`ctx.query`	`Record<string, string>`	Query string params
`ctx.jelou`	`JelouSDK`	WhatsApp messaging and deferred runs
`ctx.memory`	`MemorySDK`	Key-value session memory
`ctx.templateRegistry`	`TemplateRegistry`	Approved WhatsApp template catalog
`ctx.guard`	`Guard`	Chain of checks to run before acting
`ctx.verifyStripe()` etc.	`(req) => Promise<void>`	Webhook signature verification
`ctx.method`	`string`	HTTP method (GET, POST, etc.)
`ctx.path`	`string`	Request path
`ctx.requestId`	`string`	Unique request UUID
`ctx.isCron`	`boolean`	`true` if cron trigger
`ctx.isEvent`	`boolean`	`true` if event trigger
`ctx.isHttp`	`boolean`	`true` if HTTP request
`ctx.isScheduledFire`	`boolean`	`true` if this is a deferred run firing
`ctx.skillId`	`string \| null`	Brain Studio workflow ID
`ctx.executionId`	`string \| null`	Brain Studio execution ID
`ctx.log()`	`(...args) => void`	Structured logger

Identity

handler: async (input, ctx) => {
  ctx.company.id;    // 42
  ctx.company.name;  // "Shop ABC"
  ctx.bot.id;        // "bot-123"
  ctx.bot.channel;   // "whatsapp"
  ctx.user.id;       // 99
  ctx.user.names;    // "Maria Garcia" (optional)
}

Trigger

HTTP
Cron
Event

if (ctx.isHttp) {
  ctx.trigger; // { type: "http" }
}

if (ctx.isCron) {
  ctx.trigger.cron;     // "0 9 * * *"
  ctx.trigger.cronName; // "daily-reminder" (optional)
}

if (ctx.isEvent) {
  ctx.trigger.event; // "payment.completed"
}

Request

export default define({
  config: { path: "/users/:id" },
  handler: async (input, ctx) => {
    ctx.method;      // "GET"
    ctx.path;        // "/users/42"
    ctx.params.id;   // "42"
    ctx.query.format // "json" (from ?format=json)
    ctx.requestId;   // "a1b2c3d4-..."
  },
});

Environment (secrets)

const apiKey = ctx.env.get("CRM_API_KEY"); // string | undefined
ctx.env.has("WEBHOOK_SECRET");              // boolean
ctx.env.toObject();                         // Record<string, string>

Internal variables with __FN_ prefix are blocked — ctx.env.get("__FN_COMPANY_ID") returns undefined.

Messaging (`ctx.jelou`)

if (ctx.jelou.available) {
  await ctx.jelou.send({ type: "text", to: "+593987654321", text: "Hello" });
}

Messaging guide

14 message types, HSM templates, and error handling.

Memory (`ctx.memory`)

if (ctx.memory.available) {
  const step = await ctx.memory.get("step", "start");
  await ctx.memory.set("step", "confirm", 3600);
}

Memory guide

Primitives, JSON, TTL, limits, and common patterns.

Deferred runs (`ctx.jelou.schedule`)

Book a future run of your own function:

await ctx.jelou.schedule({
  in: "24h",
  path: "/send-followup",
  payload: { userId: input.userId, botId: ctx.bot.id },
  subject: `user_${input.userId}`,
});

Deferred runs guide

Book, look up, cancel and check before acting.

Checks (`ctx.guard`)

Chain conditions and run the action only if all of them hold. Useful when reality may have changed since you booked something:

return ctx.guard
  .when("notYetPaid", async () => !(await fetchOrder(input.orderId)).paid)
  .run(async () => {
    await ctx.jelou.send({ type: "text", to: input.phone, text: "Your payment is pending" });
    return { sent: true };
  });

If any check returns a falsy value, the chain short-circuits and returns { skipped: "<name>" } without running the action.

Webhooks (`ctx.verify*`)

Verify a webhook signature before processing it:

async handler(event, ctx, request) {
  await ctx.verifyStripe(request);
  return { received: true };
}

Webhooks guide

Stripe, Shopify, Meta and generic HMAC signatures.

Logging

ctx.log() writes structured JSON with automatic metadata:

ctx.log("Processing order", { phone: input.phone });
// stdout: { "requestId": "...", "function": "my-fn", "company": 42, "timestamp": "...", "args": [...] }

Messaging

Send WhatsApp with ctx.jelou.

Memory

Persist data with ctx.memory.

Secrets

Encrypted environment variables.

Authentication

Runtime tokens and public functions.

Getting Started

Developer

Jelou CLI

Outbound Messaging

Management

Marketplace

Channels

Configuration

Billing

Reference

Identity

Trigger

Request

Environment (secrets)

Messaging (`ctx.jelou`)

Messaging guide

Memory (`ctx.memory`)

Memory guide

Deferred runs (`ctx.jelou.schedule`)

Deferred runs guide

Checks (`ctx.guard`)

Webhooks (`ctx.verify*`)

Webhooks guide

Logging

Messaging

Memory

Secrets

Authentication

​Reference

​Identity

​Trigger

​Request

​Environment (secrets)

​Messaging (ctx.jelou)

Messaging guide

​Memory (ctx.memory)

Memory guide

​Deferred runs (ctx.jelou.schedule)

Deferred runs guide

​Checks (ctx.guard)

​Webhooks (ctx.verify*)

Webhooks guide

​Logging

Messaging

Memory

Secrets

Authentication

Reference

Identity

Trigger

Request

Environment (secrets)

Messaging (`ctx.jelou`)

Memory (`ctx.memory`)

Deferred runs (`ctx.jelou.schedule`)

Checks (`ctx.guard`)

Webhooks (`ctx.verify*`)

Logging