API Reference
Guides

Retrieve Webhooks

get
https://api.test.payadvantage.com.au/v3/webhooks

Webhooks serve as a mechanism that enables real-time communication between different web applications or services.
They facilitate the automatic transmission of data from one application to another as soon as a specific event occurs.
Essentially, when an event is triggered in the Pay Advantage application, a pre-configured URL (endpoint) in your application is notified, allowing it to process the data and initiate subsequent actions or updates.
This seamless flow of information allows developers to be automatically notified about Pay Advantage events and respond to them accordingly.
The list of support events can be found here: https://docs.payadvantage.com.au/docs/webhook-events


Gets all current webhooks that have not been accepted.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 0
Defaults to 0

Responses are paged to return a limited amount of records. This parameter is used to retrieve a specific page number.

integer
0 to 1000
Defaults to 100

The number of records per page to retrieve.

sort
array of strings

A comma seperated list of fields to sort by. Fields prefixed with a "-" will sort in descending order.
The fields include: datecreated,-datecreated

sort
boolean

Indicates whether the webhook raised an error status which is more than or equal to 300.

string
length between 6 and 8

Unique internal identifier specific to a single webhook.

webhookevents
array of strings

Returns webhooks records based on a webhook event that was raised.

webhookevents
date-time
length between 8 and 33

Returns webhook records based on date and time they were created. This field accepts date strings as yyyy-MM-dd. datecreatedto and datecreatedfrom allow you to submit a range of dates. e.g. datecreated=yyyy-MM-dd

date-time
length between 8 and 33

Returns webhook records based on date and time they were created. This field accepts date strings as yyyy-MM-dd. datecreatedto and datecreatedfrom allow you to submit a range of dates. e.g. datecreated=yyyy-MM-dd

date-time
length between 8 and 33

Returns webhook records based on date and time they were created. This field accepts date strings as yyyy-MM-dd. datecreatedto and datecreatedfrom allow you to submit a range of dates. e.g. datecreated=yyyy-MM-dd

int32

Filter records by their merchant ID.

string
enum

Filter records by their status.

Allowed:
string

Filter records by their endpoint code.

boolean

Setting the value to 'true' will provide the resource data object related to the webhook event in the response.

boolean

Setting the value to 'true' will provide details about the response received from the webhook's destination.

string

Filter records by their resource ID.

Responses

Updated 8 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago