Connectors and Webhooks

Connectors and execution webhooks solve opposite sides of integration work. Connectors let B3OS call external systems. Execution webhooks let your systems receive signed B3OS run events.

Create a Connector

The connector type decides the required data shape. Use connector-type discovery in the app or API before writing provisioning code.

bash
curl -X POST "https://api.b3os.org/v1/connectors" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "Production Telegram bot",    "type": "telegram-bot",    "description": "Bot used for production workflow alerts.",    "data": {}  }'

Connector data is provider-specific and should come from a secure backend or the B3OS app, not shell history or copied secrets in documentation.

Use a Connector in a Node

json
{  "type": "send-telegram-message",  "connector": {    "type": "telegram-bot",    "id": "conn_telegram_bot"  },  "payload": {    "chatId": "123456789",    "text": "Workflow {{$nodes.format.result.formatted}}"  },  "children": []}

Subscribe to Execution Events

bash
curl -X POST "https://api.b3os.org/v1/execution-webhooks" \  -H "Authorization: Bearer YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "name": "Production run events",    "url": "https://example.com/b3os/events",    "description": "Receives workflow run and node execution events.",    "subscribedEventTypes": [      "run.completed",      "run.failed",      "node.failed"    ],    "maxRetries": 5  }'

Delivery Operations

Verify the Signature

See Execution Hooks for signing headers, event fields, retry behavior, and verification guidance.