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

PEXA Notification Service [$]

PEXA Notification Service [$] from PEXA — 6 path(s) described in OpenAPI.

PEXA Notification Service [$] is one of 5 APIs that PEXA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 6 paths, and defines 19 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.pexa.com.au, https://api-tst.pexalabs.com.au.

7 operations 6 paths 19 schemas 1 DELETE1 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api.pexa.com.au
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

PEXA Notification Service [$] declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 5 scopes.

Paths & Operations 7

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

NotificationRegistration 7

Registration related endpoints

POST
/v3/notification-registrations
Create registration details (V3)
createNotificationRegistrationV3 body → 200400401403500
PUT
/v3/notification-registrations/{registrationId}
Update registration details (V3)
updateNotificationRegistrationV3 1 param body → 200400401403404500
GET
/v2/notification-registrations
Get notification registrations
getNotificationRegistrationsV2 3 params → 200400401403500
POST
/v1/notification-registrations
Create registration details
createNotificationRegistration body → 200400401403500
PUT
/v1/notification-registrations/{registrationId}
Update registration details
updateNotificationRegistration 1 param body → 200400401403404500
DELETE
/v1/notification-registrations/{registrationId}
Delete registration details
deleteNotificationRegistration 1 param → 204400401403404500
POST
/v1/notification-registrations/{registrationId}/secret-rotation
Rotate Shared Secret
createNotificationSecretRotation 1 param → 200400401403404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are NotificationRegistrationResponseV2 (11 properties), WebhookNotificationRegistrationResponseV3 (11 properties), NotificationRegistrationCreateDto (9 properties), WebhookNotificationRegistrationUpdateResponseV3 (9 properties). Each schema is shown below with its type and property counts.

CreateNotificationRegistrationRequest
object
Request body for creating a new webhook notification registration. Provide the webhook URI where PEXA will deliver events, and the list of event types you wish…
2 properties 2 required
UpdateNotificationRegistrationRequest
object
Update registration details
2 properties 2 required
NotificationRegistrationDto
object
Response body returned after updating a webhook registration. Note that the shared secret is not returned on update. Ensure you have securely stored the shared…
7 properties 2 required
NotificationRegistrationCreateDto
object
Response body returned after successfully creating a webhook registration. Store the sharedSecret securely (e.g. in a secrets manager). It is used to verify th…
9 properties 2 required
NotificationSecretRotationDto
object
Response body returned after rotating the shared secret. The new sharedSecret must be stored securely and used immediately for HMAC signature verification. The…
2 properties 2 required
AuthenticationMode
string
Authentication mode for webhook notifications. Allowed values: HMAC, HMACOAUTH
ClientAuthMethod
string
OAuth 2.0 client authentication method. Allowed values: privatekeyjwt, clientsecret
AuthConfig
object
6 properties 3 required
AuthConfigResponse
object
OAuth configuration returned in registration responses.
5 properties
WebhookNotificationRegistrationRequest
object
V3 webhook registration request
3 properties 3 required
WebhookNotificationRegistrationResponseV3
object
Response body returned after successfully creating a V3 webhook registration. Store the sharedSecret securely. It is used to verify the HMAC signature on all i…
11 properties
WebhookNotificationRegistrationUpdateResponseV3
object
Response body returned after updating a V3 webhook registration. Note that the shared secret is not returned on update. Ensure you have securely stored the sha…
9 properties
NotificationRegistrationResponseV2
object
A single registration record returned by the V2 GET endpoint.
11 properties
PagedNotificationRegistrations
object
A paginated list of notification registrations
2 properties 2 required
Page
object
4 properties 4 required
Error
object
Detailed error related to the API
3 properties
NotificationServiceErrorResponse
object
Response object of the service
1 property
SubscriberNotificationPayload
object
3 properties
NonSubscriberNotificationPayload
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pexa-notification-service-openapi.yaml Raw ↑

Other APIs PEXA publishes across the network.

PEXA Exchange API
PEXA Standalone Discharge Experience API
PEXA Plus Marketplace B2B API
PEXA Projects API
Where this information came from

This is an independent, third-party profile of PEXA Notification Service [$], 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.