Skip to main content
POST
/
api
/
v2
/
webhooks
Creates a new webhook setting
curl --request POST \
  --url https://gateway.paybyrd.com/api/v2/webhooks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://your-url.com/webhook"
}
'
{
  "id": "8668e1dc-3f0c-407d-9aff-f5dda1ee8eaf",
  "url": "https://your-url.com/webhook",
  "webhookUser": "b73e9449-e1dc-485a-b4c7-19c540e96cd1",
  "webhookPassword": "@bc123",
  "events": []
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string
required

Your server URL to receive the notifications from Paybyrd

Response

201 - application/json

201

​
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[]