v1

latestOpenAPI 3.0.3Proprietaryraw.githubusercontent.com2026-03-067260437.0 KB

Webhooks

Create webhook

Create a new webhook endpoint to receive event notifications.

gigstack Connect: Create webhooks for other teams using the team parameter.

post/webhooks

Query parameters

teamstring

gigstack Connect: Target team ID for multi-team access.

Requires gigstack Connect enabled on your team and shared billing account.

Example: ?team=team_xyz789

Request body

urlstring url required

HTTPS endpoint URL to receive webhook events

eventsstring[] required

Array of event types to subscribe to (at least one required)

descriptionstring nullable

Optional description of the webhook purpose

status'active' | 'inactive' nullable

Webhook status - defaults to active

Example request

{
  "url": "https://your-domain.com/webhooks/gigstack",
  "events": [
    "payment.created",
    "payment.succeeded"
  ],
  "description": "Production webhook for payment events",
  "status": "active"
}

Response

Webhook created successfully

successboolean

messagestring

Example response

{
  "success": true,
  "message": "Webhook created successfully",
  "data": {
    "id": "wh_dyS2ZVTj",
    "url": "https://your-domain.com/webhooks/gigstack",
    "events": [
      "payment.created",
      "payment.succeeded",
      "invoice.created"
    ],
    "status": "active",
    "description": "Production payment notifications",
    "owner": "8UWdgXELUhf022vuoq249mtGytG2",
    "created_at": 1709090576567
  }
}