Technical Documentation

1. Create Your Account

Sign up with your email. No password required - we'll send you a magic link.

2. Get Your Webhook URL

After logging in, copy your unique webhook endpoint from the dashboard.

3. Send Webhooks

POST any JSON payload to your webhook URL. We'll forward it in real-time.

curl -X POST https://websocks.io/api/in/YOUR_SLUG \
  -H "Content-Type: application/json" \
  -d '{"event": "user.signup", "email": "test@example.com"}'

4. Receive Events

Connect to our SSE or WebSocket endpoint to receive webhooks in real-time.

const ws = new WebSocket('wss://ws.websocks.io?token=YOUR_TOKEN');
ws.onmessage = (event) => {
  const webhook = JSON.parse(event.data);
  console.log('Received:', webhook);
};

Receive webhook events from third-party services.

Request

Response Codes

Server-Sent Events stream for real-time webhook delivery.

Query Parameters

Example

const eventSource = new EventSource(
  'https://websocks.io/api/events/stream?token=YOUR_TOKEN'
);

eventSource.onopen = () => {
  console.log('Connected to WebSocks SSE');
};

eventSource.onmessage = (event) => {
  const data = JSON.parse(event.data);
  if (data.type === 'webhook') {
    console.log('Webhook received:', data.payload);
  }
};

eventSource.onerror = (error) => {
  console.error('SSE error:', error);
  eventSource.close();
};

WebSocket endpoint for bidirectional real-time communication.

Query Parameters

Browser Example

const ws = new WebSocket('wss://ws.websocks.io?token=YOUR_TOKEN');

ws.onopen = () => {
  console.log('Connected to WebSocks WebSocket');
};

ws.onmessage = (event) => {
  const webhook = JSON.parse(event.data);
  console.log('Webhook received:', webhook);
};

ws.onerror = (error) => {
  console.error('WebSocket error:', error);
};

ws.onclose = () => {
  console.log('Disconnected from WebSocks');
};

Node.js Example

const WebSocket = require('ws');

const ws = new WebSocket('wss://ws.websocks.io?token=YOUR_TOKEN');

ws.on('open', () => {
  console.log('Connected to WebSocks WebSocket');
});

ws.on('message', (data) => {
  const webhook = JSON.parse(data);
  console.log('Webhook received:', webhook);
});

ws.on('error', (error) => {
  console.error('WebSocket error:', error);
});

ws.on('close', () => {
  console.log('Disconnected from WebSocks');
});