OPopenpayd

List Webhook Endpoints

Get a list of all webhook endpoints filtered by various params.

get/webhooks

Request

  • Base URL
    https://sandbox.openpayd.com/api
  • URL
    https://sandbox.openpayd.com/api/webhooks
  • Auth
    API key in header Authorization

Query parameters

urlstring

URL of the webhook endpoint.

transactionTypestring
transactionStatusstring
sizeinteger
pageinteger
sortstring

Sort by parameters. e.g. sort=id

Response

200

emptyboolean
firstboolean
lastboolean
numberinteger
numberOfElementsinteger
sizeinteger
totalElementsinteger
totalPagesinteger

Example response

{
  "content": [
    {
      "createdOn": "2020-06-03T09:32:02.628Z",
      "id": "JnVtcmVVVEJDVEd4T3VsenhaU0VmZz17",
      "description": "My Webhook",
      "enabled": true,
      "url": "https://example.com/webhook/endpoint",
      "webhookEvents": [
        {
          "transactionStatus": "FAILED",
          "transactionType": "PAYOUT"
        }
      ]
    }
  ],
  "first": true,
  "last": true,
  "number": 1,
  "numberOfElements": 1,
  "pageable": {
    "page": 1,
    "size": 1,
    "sort": "string"
  },
  "size": 1,
  "sort": {
    "unsorted": true
  },
  "totalElements": 1,
  "totalPages": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.