Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zuper Webhooks API

Webhook registration and event subscription management

Zuper Webhooks API is one of 14 APIs that Zuper publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhooks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, a changelog, and authentication docs.

This API exposes 6 operations across 3 paths. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against 2 base URLs: https://{dc_region}.zuperpro.com/api, https://accounts.zuperpro.com/api.

6 operations 3 paths 0 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://accounts.zuperpro.com/api
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Zuper Webhooks API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated from Zuper Settings Developer Hub API Keys

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Webhooks 6

Webhook registration and event subscription management

GET
/webhooks
Get Webhooks
getWebhooks → 200
POST
/webhooks
Create a Webhook
createWebhook body → 200400
GET
/webhooks/{webhook_uid}
Get Webhook Details
getWebhookDetails 1 param → 200404
PUT
/webhooks/{webhook_uid}
Update Webhook
updateWebhook 1 param body → 200
DELETE
/webhooks/{webhook_uid}
Delete Webhook
deleteWebhook 1 param → 200
PUT
/webhooks/{webhook_uid}/activate
Activate/Deactivate Webhook
activateWebhook 1 param body → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zuper-webhooks-api-openapi.yml Raw ↑

Other APIs Zuper publishes across the network.

Zuper Assets API
Zuper Authentication API
Zuper Customers API
Zuper Invoices API
Zuper Jobs API
Zuper Organizations API
Zuper Projects API
Zuper Properties API
Zuper Purchase Orders API
Zuper Teams API
Zuper Timesheets API
Zuper Users API