How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Pax8 Webhooks API

The Webhooks API from Pax8 — 8 operation(s) for webhooks.

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

Tagged areas include Webhook. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 11 operations across 8 paths, and defines 18 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.pax8.com/v1.

11 operations 8 paths 18 schemas 2 DELETE2 GET6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Base URL
https://api.pax8.com/v1
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

Pax8 Webhooks API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow. By default, every request must be authenticated.

Paths & Operations 11

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

Webhooks 11
GET
/webhooks
Query webhooks
Webhooks_query 8 params → 200400401403500
POST
/webhooks
Create webhook
Webhooks_create body → 200400401403500
GET
/webhooks/{id}
Get webhook by ID
Webhooks_get 1 param → 200400401403404500
DELETE
/webhooks/{id}
Delete webhook
Webhooks_delete 1 param → 204400401403404500
POST
/webhooks/{id}/configuration
Update webhook configuration
updateConfiguration 1 param body → 200400401403500
POST
/webhooks/{id}/status
Update webhook status
updateStatus 1 param body → 200400401403500
POST
/webhooks/{id}/topics
Add webhook topic
addWebhookTopic 1 param body → 200400401403500
PUT
/webhooks/{id}/topics
Replace all webhook topics
replaceWebhookTopics 1 param body → 200400401403500
DELETE
/webhooks/{id}/topics/{topicId}
Remove webhook topic
removeWebhookTopic 2 params → 204400401403500
POST
/webhooks/{id}/topics/{topicId}/configuration
Update topic configuration
updateWebhookTopicConfiguration 2 params body → 200400401403500
POST
/webhooks/{id}/topics/{topic}/test
Test webhook topic
testWebhookTopic 2 params → 200400401403500

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Webhook (13 properties), CreateWebhook (8 properties), UpdateWebhookConfiguration (5 properties), Page (4 properties). Each schema is shown below with its type and property counts.

Webhook
object
Webhook subscription information
13 properties 8 required
ReplaceWebhookTopics
object
Command for replacing webhook topics
1 property 1 required
ErrorType
string
The type of error that occurred
WebhookPagedResult
object
Paged response for webhooks
2 properties 2 required
Page
object
4 properties 4 required
WebhookDeliveryStatus
string
Status of webhook delivery
WebhookTest
object
Response from testing a webhook
3 properties 2 required
WebhookTopic
object
Topic configuration for a webhook subscription
3 properties 3 required
AddWebhookTopic
object
Command for webhook topic configuration
2 properties 2 required
FilterOperator
string
Filter operator for webhook conditions
UpdateWebhookTopicConfiguration
object
Command for updating webhook topic configuration
1 property 1 required
WebhookFilter
object
Filter configuration for webhook actions
2 properties 2 required
FilterCondition
object
Condition for filtering webhook events
3 properties 3 required
UpdateWebhookConfiguration
object
Command for updating a webhook's configuration
5 properties
UpdateWebhookStatus
object
Command for updating a webhook's status
1 property 1 required
UpdateWebhookFilter
object
Command for webhook filter configuration
2 properties 2 required
UpdateFilterCondition
object
Command for filter condition
3 properties 3 required
CreateWebhook
object
Command for creating a new webhook
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pax8-webhooks-api-openapi.yml Raw ↑

Other APIs Pax8 publishes across the network.

Pax8 Access Token API
Pax8 Companies API
Pax8 Contacts API
Pax8 Invoices API
Pax8 Library attachments API
Pax8 Orders API
Pax8 Preference attachments API
Pax8 Products API
Pax8 Provision Attempts API
Pax8 Provision Details API
Pax8 Provision Requests API
Pax8 Provision Results API
Where this information came from

This is an independent, third-party profile of Pax8 Webhooks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.