Skip to content

Webhooks

Allows clients to manage webhooks.

The Peach webhook system will issue POST requests with the event data as JSON payload.

Operations

Get webhooks

Request

Security
oauth2(Required scopes: webhook.subscription:list) or bearerAuth or apiKeyHeader
Query
limitinteger, [ 1 .. 100 ]

The maximum count of results to retrieve.

Default:25
startingAfterstring

Return results starting after the provided object identifier.

endingBeforestring

Return results ending before the provided object identifier.

GET
/webhooks
curl -i -X GET \
  'https://sandboxapi.peach.finance/api/webhooks?limit=25&startingAfter=string&endingBefore=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
countintegerread-only

Total number of items in this result.

statusinteger

HTTP status code.

dataArray of objects(WebhookSubscription)
Response
{
  "count": 0,
  "status": 0,
  "data": [
    { … }
  ]
}