Pax8 Webhooks API
The Webhooks API from Pax8 — 8 operation(s) for webhooks.
OpenAPI Specification
openapi: 3.0.1
info:
title: Authentication Access Token Webhooks API
version: 1.0.0
termsOfService: https://usc.pax8.com/resource/display/65345
description: The Access Token that allows access to the Pax8 API
servers:
- url: https://api.pax8.com/v1
security:
- OAuth2: []
tags:
- name: Webhooks
paths:
/webhooks:
get:
operationId: Webhooks_query
summary: Query webhooks
description: Lists instances of WebhookView with the ability to query against fields in WebhookView.
parameters:
- name: query
in: query
required: false
description: String value to query webhooks.
schema:
type: string
explode: false
- name: page
in: query
required: false
schema:
type: integer
format: int32
default: 0
explode: false
- name: size
in: query
required: false
schema:
type: integer
format: int32
default: 10
explode: false
- name: active
in: query
required: false
schema:
type: boolean
explode: false
- name: topic
in: query
required: false
schema:
type: string
explode: false
- name: sort
in: query
required: false
description: 'Sort field and order, format: field:asc/desc'
schema:
type: string
explode: false
- name: status
in: query
required: false
description: Filter value for the last delivery status of the webhook
schema:
type: string
explode: false
- name: accountId
in: query
required: false
schema:
type: string
format: uuid
explode: false
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookPagedResult'
'400':
description: The request is missing required parameters or has invalid parameters
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- BAD_REQUEST
message:
type: string
'401':
description: Missing or invalid token
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- UNAUTHORIZED
message:
type: string
'403':
description: User does not have permission to access this resource
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- FORBIDDEN
message:
type: string
'500':
description: Server error
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- INTERNAL_SERVER_ERROR
message:
type: string
tags:
- Webhooks
post:
operationId: Webhooks_create
summary: Create webhook
description: Create an instance of WebhookView.
parameters: []
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
'400':
description: The request is missing required parameters or has invalid parameters
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- BAD_REQUEST
message:
type: string
'401':
description: Missing or invalid token
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- UNAUTHORIZED
message:
type: string
'403':
description: User does not have permission to access this resource
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- FORBIDDEN
message:
type: string
'500':
description: Server error
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- INTERNAL_SERVER_ERROR
message:
type: string
tags:
- Webhooks
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWebhook'
/webhooks/{id}:
get:
operationId: Webhooks_get
summary: Get webhook by ID
description: Reads an instance of WebhookView.
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
'400':
description: The request is missing required parameters or has invalid parameters
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- BAD_REQUEST
message:
type: string
'401':
description: Missing or invalid token
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- UNAUTHORIZED
message:
type: string
'403':
description: User does not have permission to access this resource
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- FORBIDDEN
message:
type: string
'404':
description: The server cannot find the requested resource.
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- NOT_FOUND
message:
type: string
'500':
description: Server error
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- INTERNAL_SERVER_ERROR
message:
type: string
tags:
- Webhooks
delete:
operationId: Webhooks_delete
summary: Delete webhook
description: Delete an instance of WebhookView.
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
'400':
description: The request is missing required parameters or has invalid parameters
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- BAD_REQUEST
message:
type: string
'401':
description: Missing or invalid token
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- UNAUTHORIZED
message:
type: string
'403':
description: User does not have permission to access this resource
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- FORBIDDEN
message:
type: string
'404':
description: The server cannot find the requested resource.
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- NOT_FOUND
message:
type: string
'500':
description: Server error
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- INTERNAL_SERVER_ERROR
message:
type: string
tags:
- Webhooks
/webhooks/{id}/configuration:
post:
operationId: updateConfiguration
summary: Update webhook configuration
description: Update a webhook's configuration. This will replace the configuration details
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Webhook'
'400':
description: The request is missing required parameters or has invalid parameters
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- BAD_REQUEST
message:
type: string
'401':
description: Missing or invalid token
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
instance:
type: string
details:
type: array
items:
type: object
properties:
status:
type: integer
format: int32
allOf:
- type: object
required:
- type
- message
properties:
type:
$ref: '#/components/schemas/ErrorType'
message:
type: string
allOf:
- type: object
required:
- type
- message
properties:
type:
type: string
enum:
- UNAUTHORIZED
message:
type: string
'403':
description: User does not have permission to access this resource
content:
application/json:
schema:
type: object
required:
- status
properties:
status:
type: integer
format: int32
# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/pax8/refs/heads/main/openapi/pax8-webhooks-api-openapi.yml