Register an endpoint
curl --request POST \
--url https://examples.staging.rampapay.com/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "https://api.example.com/rampa/webhooks"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: 'https://api.example.com/rampa/webhooks'})
};
fetch('https://examples.staging.rampapay.com/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://examples.staging.rampapay.com/v1/webhooks"
payload = { "url": "https://api.example.com/rampa/webhooks" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "0d9b7c1e-2f4a-4e8b-b6c3-5a1f9e2d7c40",
"url": "https://api.example.com/rampa/webhooks",
"status": "active",
"consecutive_failures": 0,
"created_at": "2026-09-27T13:55:00.000Z",
"secret": "whsec_<shown only in this response>"
}Webhooks
Register an endpoint
Scope: webhooks:manage
A public HTTPS URL on the default port. The secret is returned only in this response — store it now; it is never shown again.
POST
/
webhooks
Register an endpoint
curl --request POST \
--url https://examples.staging.rampapay.com/v1/webhooks \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "https://api.example.com/rampa/webhooks"
}
'const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({url: 'https://api.example.com/rampa/webhooks'})
};
fetch('https://examples.staging.rampapay.com/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://examples.staging.rampapay.com/v1/webhooks"
payload = { "url": "https://api.example.com/rampa/webhooks" }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "0d9b7c1e-2f4a-4e8b-b6c3-5a1f9e2d7c40",
"url": "https://api.example.com/rampa/webhooks",
"status": "active",
"consecutive_failures": 0,
"created_at": "2026-09-27T13:55:00.000Z",
"secret": "whsec_<shown only in this response>"
}