Skip to main content
PUT
/
api
/
v1
/
webhook
Setup URL
curl --request PUT \
  --url https://gateway.paybyrd.com/api/v1/webhook \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "url": "https://your-url.com/webhook"
}
'
{
  "url": "https://your-url.com/webhook",
  "webhookUser": "b73e9449-e1dc-485a-b4c7-19c540e96cd1",
  "webhookPassword": "@bc123"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string
required

Your server URL to receive the notifications from Paybyrd

Response

200 - application/json

200

​
url
string
Example:

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

​
webhookUser
string
Example:

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

​
webhookPassword
string
Example:

"@bc123"