PApax8
Webhooks

Create webhook

Create an instance of WebhookView.

post/webhooks

Request

  • Base URL
    https://api.pax8.com/api/v2
  • URL
    https://api.pax8.com/api/v2/webhooks
  • Auth
    none declared

Request body

displayNamestring required

Display name for the webhook

urlstring

URL where webhook events will be sent

authorizationstring

Authorization header value for webhook commands

activeboolean

Whether the webhook is active

contactEmailstring

Email address to notify when webhook delivery errors occur

errorThresholdinteger

Number of times a webhook will be retried and consecutive errors will result in an email notification

integrationIdstring uuid

Id of the integration this webhook is associated with. This is required for 3rd party integrators

Response

The request has succeeded.

idstring uuid required

Unique identifier for the webhook

accountIdstring uuid required

Account ID that owns this webhook

displayNamestring required

Display name for the webhook

urlstring

URL where webhook events will be sent

authorizationstring

Authorization header value for webhook

activeboolean required

Whether the webhook is active

contactEmailstring

Email address to notify when webhook delivery errors occur

errorThresholdinteger required

Number of times a webhook will be retried and consecutive errors will result in an email notification

integrationIdstring uuid

Id of the integration this webhook is associated with, if applicable

lastDeliveryStatus'PENDING' | 'SUCCESS' | 'FAILED' | 'RETRYING'

Status of webhook delivery

createdAtstring date-time required

Timestamp when the webhook was created

updatedAtstring date-time required

Timestamp when the webhook was last updated

Changes

No recorded changes to this operation across all 1 revision of this API.