SupportChangelogAPI ReferenceStatus

Notifications

Stay in the loop

Asynchronous notifications of events.

Supported Events:

  • Product creation, amendment or removal.

  • Order creation, amendment or cancellation.

  • Payment creation, refund or amendment.

  • Voucher release or revocation.

  • Redemption.

List Webhooks

get

List all webhooks.

Authorizations
Query parameters
webhook_idstringOptional

Webhook ID.

Example: cf3bf1c0-0123-11ed-bb92-8dd6d349e28e
items_per_pageinteger · min: 1 · max: 200Optional

[PAGING] Items Per Page - Allows user's to configure the items_per_page value. For example, to load 100 items per page, the developer may point the user to a url with the query string ?items_per_page=100.

This parameter is mainly usefull to manage response times, higher values result in longer response times and therefore it is recommended to keep this value as low as possible. We do allow to adjust this value so it can be used to batch/cache/update inventory at once.

Clients should anticipate that the value of this parameter may not be honored by the API, and should rely exclusively on the contents of the items_per_page response element in calculating actual page size.

Default: 10Example: 5
start_indexinteger · min: 1 · max: 10000Optional

[PAGING] Index-based paging - Allows user's to jump directly to a specific item position within a list of items. For example, to load 10 items starting at item 200, the developer may point the user to a url with the query string ?start_index=200.

Default: 1Example: 1
pageinteger · min: 1Optional

[PAGING] Page-based paging - Allows user's to jump directly to a specific page within the items. This is similar to index-based paging, but saves the developer the extra step of having to calculate the item index for a new page of items. For example, rather than jump to item number 200, the developer could jump to page 20. The urls during page-based paging could use the query string ?page=1 or ?page=20. The page_index and total_pages properties are used for this style of paging.

Default: 1Example: 1
Responses
200

List all webhooks

application/json
get
GET /v3.8/distributor/webhooks HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "api_version": "3.8.0",
  "data": {
    "kind": "location",
    "current_item_count": 10,
    "items_per_page": 10,
    "start_index": 1,
    "total_items": 200,
    "page_index": 1,
    "total_pages": 20,
    "items": [
      {
        "webhook_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
        "webhook_status": "ENABLED",
        "webhook_version": "3.8.0",
        "webhook_events": [
          "ORDER_CREATE"
        ],
        "webhook_url": "https://myserver.com/send/callback/here",
        "webhook_created": "2025-08-05T13:08:09.706Z",
        "webhook_created_name": "Cashier Name",
        "webhook_created_email": "[email protected]"
      }
    ]
  }
}

Create Webhook

post

Add webhook to receive events.

Authorizations
Body

Create webhook request model.

api_versionstringRead-onlyRequired

Represents the version of the service API that's served in the response.

Example: 3.8.0
Responses
201

Webhook created

application/json
post
POST /v3.8/distributor/webhooks HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "data": {
    "webhook": {
      "webhook_events": [
        "ORDER_CREATE"
      ],
      "webhook_url": "https://myserver.com/send/callback/here"
    }
  }
}
{
  "api_version": "3.8.0",
  "data": {
    "kind": "location",
    "webhook": {
      "webhook_id": "de1829d0-e144-11ea-bc09-f935c77bef95",
      "webhook_status": "ENABLED",
      "webhook_version": "3.8.0",
      "webhook_events": [
        "ORDER_CREATE"
      ],
      "webhook_url": "https://myserver.com/send/callback/here",
      "webhook_created": "2025-08-05T13:08:09.706Z",
      "webhook_created_name": "Cashier Name",
      "webhook_created_email": "[email protected]"
    }
  }
}

Remove Webhook

delete

Remove webhook.

Authorizations
Path parameters
webhook_idstring · uuid · min: 8Required

Unique Webhook ID.

Example: de1829d0-e144-11ea-bc09-f935c77bef95
Responses
204

Webhook Removed

delete
DELETE /v3.8/distributor/webhooks/{webhook_id} HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Create Notification (Example only)

post

Trigger sample notification. Only used for testing your integration.

Authorizations
Body

Create notification request model.

api_versionstringRead-onlyRequired

Represents the version of the service API that's served in the response.

Example: 3.8.0
Responses
204

Notification(s) triggered

post
POST /v3.8/distributor/notifications HTTP/1.1
Host: staging-distributor-api.prioticket.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 126

{
  "data": {
    "notification": {
      "notification_event": "ORDER_CREATE",
      "notification_item_id": "PRODUCT_ID/PAYMENT_ID/ORDER_REFERENCE"
    }
  }
}
No content
PreviousContactsNextModels

Was this helpful?