Skip to main content
GET
/
api
/
v2
/
webhooks
Gets all webhook settings
curl --request GET \
  --url https://gateway.paybyrd.com/api/v2/webhooks \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "8668e1dc-3f0c-407d-9aff-f5dda1ee8eaf",
    "url": "https://your-url.com/webhook1",
    "webhookUser": "b73e9449-e1dc-485a-b4c7-19c540e96cd1",
    "webhookPassword": "@bc123",
    "events": []
  },
  {
    "id": "c1532b84-a819-4e7a-986e-63bfb4fb1ecf",
    "url": "https://your-url.com/webhook2",
    "webhookUser": "d75620b6-8f3e-48f3-bb7d-99ffd0dbf135",
    "webhookPassword": "@bc123",
    "events": []
  }
]

Authorizations

​
x-api-key
string
header
required

Response

200 - application/json

200

​
id
string
Example:

"8668e1dc-3f0c-407d-9aff-f5dda1ee8eaf"

​
url
string
Example:

"https://your-url.com/webhook"

​
webhookUser
string
Example:

"b73e9449-e1dc-485a-b4c7-19c540e96cd1"

​
webhookPassword
string
Example:

"@bc123"

​
events
string[]