Skip to main content
POST
/
api
/
v2
/
integrations
/
webhooks
/
test
/
Test webhook delivery
curl --request POST \
  --url https://api.zupy.com/api/v2/integrations/webhooks/test/ \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "status_code": 123,
  "error": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.

Headers

​
X-API-Key
string
required

Per-company API key

Response

​
success
boolean

Whether the test webhook was delivered successfully

​
status_code
integer | null

HTTP status code from the webhook endpoint

​
error
string | null

Error message if delivery failed