Webhooks

An agent can manage its own inbound webhooks. See Webhooks overview for how delivery works.

All examples use the @alfe.ai/agent-api-client. Each method acts on the calling agent’s webhooks.

Create a webhook

webhooks.ts

const webhook = await client.createWebhook({
  name: "Build events",     // up to 100 characters
  provider: "generic",      // optional: generic, github, stripe, or slack
});
// POST /agent/webhooks

The result includes the url to give the sender and the signingSecret.

Save the signing secret now

This is the only time the create call returns the secret. To get a new one, rotate it.

List webhooks

const webhooks = await client.listWebhooks();
// GET /agent/webhooks

Each entry has webhookId, name, provider, and active. Listing doesn’t return the secret.

Rotate the signing secret

const { signingSecret } = await client.rotateWebhookSecret(webhookId);
// POST /agent/webhooks/{webhookId}/rotate

Read deliveries

const deliveries = await client.listWebhookDeliveries(webhookId);
// GET /agent/webhooks/{webhookId}/deliveries

Each delivery has deliveryId, status, attempts, createdAt, and, once delivered, deliveredAt.

Delete a webhook

await client.deleteWebhook(webhookId);
// DELETE /agent/webhooks/{webhookId}  →  { webhookId, active: false }

Related resources

• Manage webhooks — the agent’s tools and common tasks.
• Webhook signatures — sign the requests you send.