Getting Started

Send your first webhook with Von in under 5 minutes.

Prerequisites

Before you begin, make sure you have the following:

• A Von account, which you can create for free
• Node.js 18 or later installed on your machine
• An API key generated from the API Keys page in the dashboard

Setup

• 1

  Install the SDK

  Let's start by adding Von to your project:

  bunnpmpnpm

  bun add @usevon/sdk
  

• 2

  Configure environment

  Create a .env file and add the API key. The key authenticates all requests to the Von API and determines which environment (development, staging, or production) webhooks are sent from.

  VON_API_KEY=von_live_xxxxxxxxxxxxx
  

• 3

  Initialize the client

  import { Von } from "@usevon/sdk";
  
  const von = new Von({
    apiKey: process.env.VON_API_KEY,
  });
  

• 4

  Create an endpoint

  An endpoint is the destination URL where Von delivers webhooks.

  const endpoint = await von.endpoints.create({
    url: "https://your-app.com/webhooks",
    description: "Production webhook endpoint",
  });
  

• 5

  Send a webhook

  const webhook = await von.webhooks.send({
    endpointId: endpoint.id,
    eventType: "user.created",
    payload: {
      userId: "user_123",
      email: "user@example.com",
      createdAt: new Date().toISOString(),
    },
  });
  

• 6

  View in dashboard

  Once sent, the webhook appears in the Von dashboard where you can monitor delivery status, view response codes, and debug any failures.

Next Steps

• Introduction: Learn about endpoints, events, and environments
• Sending Webhooks: Retries, delivery, and event types
• Verification: Secure webhook endpoints with signatures