Webhook Provider Recipes

Practical examples for common event providers.

GitHub Webhook (issues)

Payload URL:
https://<convex-site>.convex.site/api/v1/workspaces/webhooks/ingest?workspaceId=<workspaceId>&webhookId=<webhookId>

Secret:
<same value as X-Sutraha-Webhook-Secret>

Content type:
application/json

Events:
Issues, Issue comments (or desired subset)

Zapier Webhooks by Zapier

Method: POST
URL: https://<convex-site>.convex.site/api/v1/workspaces/webhooks/ingest?workspaceId=<workspaceId>&webhookId=<webhookId>
Headers:
  X-Sutraha-Webhook-Secret: <secret>
  X-Provider-Event-Id: {{zap_meta_human_now}}
Body:
  {"event":{"type":"zap.trigger"},"payload":{...}}

Generic server-to-server sender

POST /api/v1/workspaces/webhooks/ingest?workspaceId=<workspaceId>&webhookId=<webhookId>
X-Sutraha-Webhook-Secret: <secret>
X-Provider-Event-Id: <unique-event-id>
Content-Type: application/json

{
  "event": { "type": "source.event" },
  "payload": {
    "title": "Optional title",
    "message": "Optional message",
    "raw": { "any": "json" }
  }
}