Skip to main content
GET
/
api
/
v2
/
integrations
/
webhooks
/
Get webhook configuration
curl --request GET \
  --url https://api.zupy.com/api/v2/integrations/webhooks/ \
  --header 'X-API-Key: <api-key>'
{
  "webhook_url": "<string>",
  "webhook_events": [
    "<string>"
  ],
  "webhook_secret": "<string>",
  "available_events": [
    "<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

​
webhook_url
string | null

Partner's webhook endpoint URL

​
webhook_events
string[]

List of events to receive

​
webhook_secret
string | null

Masked webhook signature secret (last 4 chars visible)

​
available_events
string[]

List of available webhook event types