post

/2.0/alert/webhooks

Retrieve past events and alerts that Paddle has sent to webhooks on your account

Example Request

curl -X POST \
     -d 'vendor_id=123...' \
     -d 'vendor_auth_code=1g3g456abc' \
     -d 'query_head=2021-01-20 23:59:59' \
     -d 'query_tail=2021-01-20 00:00:00' \
     https://vendors.paddle.com/api/2.0/alert/webhooks

Usage Notes

We strongly recommend that you utilize the query_head and query_tail to limit your search to no more than any 24-hour period when calling this API. This ensures that the API response time remains quick and consistent as the amount of events/alerts build up over time.

Request Body

Form data (application/x-www-form-urlencoded)

vendor_id

integer

The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.

required

minimum: 1

pattern: \d+

vendor_auth_code

string

The vendor auth code is a private API key for authenticating API requests. This key should never be used in client side code or shared publicly. This can be found in Developer Tools > Authentication.

required

pattern: [0-9a-f]+

page

integer

Paginate returned results.

minimum: 1

pattern: \d+

alerts_per_page

string

Number of webhook alerts to return per page. Returns 10 alerts by default.

minLength: 1

pattern: \d+

query_head

string

The date and time (UTC - Coordinated Universal Time) at which the webhook occurred before (end date). In the format: YYYY-MM-DD HH:MM:SS

format: date-time

pattern: [0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) (2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]

query_tail

string

The date and time (UTC - Coordinated Universal Time) at which the webhook occurred after (start date). In the format: YYYY-MM-DD HH:MM:SS

format: date-time

pattern: [0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) (2[0-3]|[01][0-9]):[0-5][0-9]:[0-5][0-9]

Responses

1 Example

Schema

object

An unsuccessful call to the Dashboard API will return a 200 response containing a field success set to false and an error object.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)

$$.env

No $$.env variables are being used in this request.