PEXA

PEXA Notification Service [$] API

The Notification Service [$] API from PEXA — 0 operation(s) for notification service [$].

Documentation GitHub OpenAPI

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/pexa-notification-service-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Notification Service [$] API
  description: The Push Notifications Service handles delivering notifications via webhook to subscribers and manages the registration of subscribers for specific events.
  version: 1.0.0
  contact:
    email: apisupport@pexa.com.au
servers:
- url: https://api.pexa.com.au
  description: Production server
- url: https://api-tst.pexalabs.com.au
  description: Non-Prod server
tags:
- name: Notification Service
paths: {}
webhooks:
  SubscriberNotification:
    post:
      description: Subscriber notification payload
      operationId: SubscriberNotification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriberNotificationPayload'
      responses:
        '200':
          description: Callback successfully processed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '200'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Callback successfully processed
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '400'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Bad Request
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '404'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Not Found
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '408'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Request Timeout
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '418':
          description: I'm a teapot
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '418'
                  message:
                    type:
                    - string
                    - 'null'
                    example: I'm a teapot
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '429'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Too Many Requests
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '500'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Internal Server Error
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '502'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Bad Gateway
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '503'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Service Unavailable
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '504':
          description: Gateway Timeout
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '504'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Gateway Timeout
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
      tags:
      - Notification Service
      summary: Subscriber notification
      x-summary-source: derived
  NonSubscriberNotification:
    post:
      description: Non-subscriber notification payload
      operationId: nonSubscriberNotification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NonSubscriberNotificationPayload'
      responses:
        '200':
          description: Callback successfully processed
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '200'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Callback successfully processed
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '400'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Bad Request
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '404'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Not Found
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '408':
          description: Request Timeout
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '408'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Request Timeout
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '418':
          description: I'm a teapot
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '418'
                  message:
                    type:
                    - string
                    - 'null'
                    example: I'm a teapot
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '429'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Too Many Requests
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '500'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Internal Server Error
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '502'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Bad Gateway
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '503'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Service Unavailable
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
        '504':
          description: Gateway Timeout
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    example: '504'
                  message:
                    type:
                    - string
                    - 'null'
                    example: Gateway Timeout
                  data:
                    type:
                    - string
                    - 'null'
                    example: Some data
      tags:
      - Notification Service
      summary: Non subscriber notification
      x-summary-source: derived
components:
  schemas:
    SubscriberNotificationPayload:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          description: The date and time the event occurred
          example: '2024-06-04T03:18:58Z'
        type:
          type: string
          description: Specifies the category and the event type and follows the format of <category>.<event>
          example: Workspace.CHECKLIST_CHECKED
        data:
          type: object
          description: An object containing the details of the events that triggered the notification
          properties:
            workspaceId:
              type: string
              description: The PEXA Workspace Identifier
              example: PEXA000000000
            subscriberId:
              type: string
              description: The ID of the subscriber
              example: '100'
            subscriberReferences:
              type: array
              description: An array of subscriber references that are relevant to the event.
              items:
                type: object
                description: Subscriber reference or identifier provided by third parties like financial institutions. Used to link a PEXA Workspace to an integrators system
                properties:
                  subscriberReference:
                    type: string
                    description: The subscriber reference
                    example: '100'
                  workspaceRole:
                    type: string
                    description: The role of the subscriber in the workspace
                    example: Incoming Mortgagee
            additionalReferences:
              type: array
              description: An array of additional references that are relevant to the event. For subscriber notifications, this will contain a single reference
              items:
                type: object
                description: Additional reference or identifier provided by third parties like financial institutions. Used to link a PEXA Workspace to an integrators system
                properties:
                  identifier:
                    type: string
                    description: The identifier
                    example: '51'
                  type:
                    type: string
                    description: The type of reference.
                    example: CHECKLIST_ITEM_ID
    NonSubscriberNotificationPayload:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          description: The date and time the event occurred
          example: '2024-06-04T03:18:58Z'
        type:
          type: string
          description: Specifies the category and the event type and follows the format of <category>.<event>
          example: Workspace.CHECKLIST_CHECKED
        data:
          type: object
          description: An object containing the details of the events that triggered the notification
          properties:
            workspaceId:
              type: string
              description: The PEXA Workspace Identifier
              example: PEXA000000000
            additionalReferences:
              type: array
              description: An array of additional references that are relevant to the event. For non-subscriber notifications, this will contain a single reference
              items:
                type: object
                description: Additional references.
                properties:
                  identifier:
                    type: string
                    description: The identifier
                    example: '51'
                  type:
                    type: string
                    description: The type of reference.
                    example: CHECKLIST_ITEM_ID
            links:
              type: array
              description: A list of links to get further information about the workspace that triggered the notification
              items:
                type: object
                description: A link to get further information about the workspace that triggered the notification. Each link follows the HATEOAS standard
                properties:
                  href:
                    type: string
                    description: The URL to get the workspace details
                    example: https://example.com/workspace123
                  rel:
                    type: string
                    description: Provides context to the type of information that can be received from the href
                    example: self
                  type:
                    type: string
                    description: The type of HTTP request to be used for the href
                    example: GET
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://auth.pexa.com.au/oauth/token
          scopes:
            view:notification_registrations: View registrations
            create:notification_registrations: Create registrations
            edit:notification_registrations: Edit registrations
            delete:notification_registrations: Delete registrations
            create:notification_registrations_secret_rotation: Rotate shared secret