API Reference

Webhooks API

Trigger a workflow from an external HTTP call, and receive inbound events from third-party integrations.

Overview

Vouchstone webhooks are inbound, not a generic outbound event-subscription system: there is no agent.message.completed-style event catalog you subscribe an endpoint to. Two real things exist under this name:

  • Workflow triggers — create a webhook on a workflow and get back a unique URL; POSTing to that URL executes the workflow.
  • Integration event receivers — fixed endpoints under /api/v1/webhooks/integrations/* that Slack, GitHub, Jira, Linear, PagerDuty, and Confluence call to deliver events into Vouchstone (see the Slack, GitHub, and Jira integration guides) — these are configured when you set up the integration, not something you call directly.

Create a Workflow Webhook Trigger

POST /api/v1/workflows/{workflow_id}/webhooks
# Request
curl -X POST "https://www.vouchstone.ai/api/v1/workflows/wf_abc123/webhooks?tenant_id=tenant_xyz" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Order received",
    "allowed_methods": ["POST"]
  }'

# Response
{
  "id": "wh_def456",
  "path": "a1b2c3d4...",
  "name": "Order received",
  "url": "/api/v1/webhooks/trigger/a1b2c3d4...",
  "is_active": true,
  "trigger_count": 0,
  "allowed_methods": ["POST"]
}

POST to {url} (prefixed with your API base URL) to execute the workflow. The trigger's secret is returned only once, at creation.

List / Delete Workflow Webhooks

GET /api/v1/workflows/{workflow_id}/webhooks
DELETE /api/v1/workflows/{workflow_id}/webhooks/{webhook_id}
curl "https://www.vouchstone.ai/api/v1/workflows/wf_abc123/webhooks?tenant_id=tenant_xyz" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Integration Event Receivers

Fixed inbound endpoints — point the third-party service's webhook configuration at these:

PathSource
/api/v1/webhooks/integrations/slackSlack events & slash commands
/api/v1/webhooks/integrations/githubGitHub repository events
/api/v1/webhooks/integrations/jiraJira issue events
/api/v1/webhooks/integrations/linearLinear issue events
/api/v1/webhooks/integrations/pagerdutyPagerDuty incident events
/api/v1/webhooks/integrations/confluenceConfluence page events
Continue to Slack Integration