Skip to main content
PATCH
/
v1
/
sender
/
webhook
{ "webhook_url": "https://your-app.com/hooks/rails" }

{
  "status": "success",
  "message": "Webhook URL updated",
  "data": {
    "sender_profile_id": "e7c194a0-3c4c-48c4-8235-4ba7dc94fa40",
    "webhook_url": "https://your-app.com/hooks/rails",
    "domain_whitelist": ["https://your-app.com"]
  }
}
Set or change the webhook URL Rails calls when your orders change state (settled, refunded, expired). Authenticated with your API key — you manage this yourself. To view your current webhook, call Get Account.

​
Header Parameters

​
API-Key
string
required
Unique API key issued manually through Telegram.

​
Request Body

​
webhook_url
string
required
A valid HTTPS URL Rails will POST status events to.
​
scopes
array
Optional domain whitelist. Only updated when provided — omit it and your existing whitelist is preserved.

​
Response

​
status
string
Response state (success).
​
data
object
​
sender_profile_id
string
Your sender profile id.
​
webhook_url
string
The stored webhook URL.
​
domain_whitelist
array
The current whitelist.
{ "webhook_url": "https://your-app.com/hooks/rails" }

{
  "status": "success",
  "message": "Webhook URL updated",
  "data": {
    "sender_profile_id": "e7c194a0-3c4c-48c4-8235-4ba7dc94fa40",
    "webhook_url": "https://your-app.com/hooks/rails",
    "domain_whitelist": ["https://your-app.com"]
  }
}