quipteams API
POST/webhooks
scopewebhooks:writereturns201

Create a webhook endpoint

Registers an endpoint. The signing `secret` (prefix `whsec_`) is returned exactly once in this response - store it now; it is never shown again. `url` must be HTTPS (localhost is allowed for testing).

Body

urlrequired
stringHTTPS callback URL.
eventsrequired
string[]One or more event names or wildcards (see Webhook signatures / event list).
description
stringOptional label.

Example request

json
{
  "url": "https://example.com/hooks/quipteams",
  "events": ["quote.*", "device_action.status"],
  "description": "Production order + logistics events"
}

Example response

json
{
  "data": {
    "id": "62744637-a8b9-4c0d-9e2f-304152637485",
    "url": "https://example.com/hooks/quipteams",
    "events": ["quote.*", "device_action.status"],
    "description": "Production order + logistics events",
    "is_active": true,
    "created_by": "api",
    "created_at": "2026-02-01T00:00:00.000Z",
    "secret": "whsec_3f9a...store-this-now...c71e"
  }
}