Account

Set webhook URLs

POSThttps://api.smsedge.com/v1/user/set-webhook/

Sets or clears the URLs that receive delivery reports, clicks, inbound SMS and click revocations.

Only the parameters you send are changed. A parameter you leave out keeps its current value. Send an empty string (for example inbound_url=) to clear a URL.

Each URL must be a valid URL of 255 characters or less. auth is HTTP Basic credentials in the form user:pass (32 characters max, must contain a colon). It is used for the delivery report webhook only.

The response shows the full webhook setup after the change. auth is returned as true or false, never the credentials.

Body params (form)

  • dlr_urlstringoptional

    URL that receives delivery reports (DLR) for your messages. Empty string clears it.

  • click_urlstringoptional

    URL that receives a call when a recipient clicks a shortened link. Empty string clears it.

  • inbound_urlstringoptional

    URL that receives inbound (reply) SMS. Empty string clears it.

  • revoke_click_urlstringoptional

    URL that receives a batch notice when clicks are revoked as bot clicks. Empty string clears it.

  • authstringoptional

    HTTP Basic credentials for the DLR webhook, as user:pass (max 32 characters). Empty string clears it.

Responses

  • 200Webhook setup after the change
  • 400A value failed validation. errors is an object keyed by parameter name.
  • 401The API key is missing, wrong or the account is blocked
curl -X POST "https://api.smsedge.com/v1/user/set-webhook/" \
  -H "X-API-KEY: YOUR_API_KEY" \
  --data-urlencode "dlr_url=https://example.com/webhooks/dlr" \
  --data-urlencode "click_url=https://example.com/webhooks/click"
[
  {
    "success": true,
    "data": {
      "dlr_url": "https://example.com/webhooks/dlr",
      "click_url": "https://example.com/webhooks/click",
      "inbound_url": "https://example.com/webhooks/inbound",
      "revoke_click_url": "https://example.com/webhooks/revoke-click",
      "auth": true
    },
    "errors": [],
    "response": {
      "code": 200,
      "description": "OK",
      "date": "2026-11-16 14:05:00"
    },
    "api": {
      "version": "v1",
      "module": "user",
      "function": "set-webhook"
    },
    "user": {
      "id": 736
    }
  }
]

All requests need your API key in the X-API-KEY header. See Authentication.